Copyright: Copyright© 1992-1996, StarBase Corporation
Citation: Copyright© 1992-1996, StarBase Corporation. All rights reserved.


$NoKeywords$


 add files

The process of placing files under version control by adding them to a Versions project.


 administrator

A functional role in the operation of Versions. To become a project administrator, you must be the first user created for the project, import the project, or have another administrator change your user properties to designate you as an administrator.
When project security is enabled, only project administrators can create or branch subprojects, change project properties, break locks, manage team member information, modify the number of versions for a file, designate or delete permanent versions, purge non-permanent versions, designate builds and milestones, and perform delete operations.


 alphanumeric

A value consisting of the letters A-Z, and the digits 0-9.


 archive

For PVCS users, a synonym for vault.
Others often use it to mean a backup copy of a program or data file saved to ensure against loss in case the original materials are deleted or damaged. Archived files can be stored on tape, floppy disks, or another computer system.


 audit entry

A record of an action performed on a Versions project that appears in the audit log. For example, every time a file is added to a project, that action is entered in the audit log.


 audit log

A chronological record kept by Versions showing all actions performed on Versions projects, subprojects, files, and users.


 audit trail

A chronological record kept by Versions showing all actions performed on a project, subproject, file, or user. A tab for a project, or subproject, file, or user's properties.


 author

Information stored by Versions about files, and responses.

For a file:	The user who added the file to the project.

For a version:	The user who checked in the version.


 automatic refresh

An automatic update feature of Versions. Since projects, subprojects, and files managed by Versions are subject to continuous revision by various team members, screen information can become outdated after it is first displayed. The Automatic Refresh function periodically reads the project database to update the displayed information.


 binary file

Any file that is not strictly an ASCII text file. Binary files contain programs or data in machine code. Examples of binary files and their respective file name extensions are executables (.exe), resources (.res), word processing documents (.doc in Word for Windows), spreadsheets (.xls in Excel), object files (.obj) and bitmaps (.bmp).


 branch

The process of creating a second, independent subproject from the contents of an existing subproject. The branch may become a project in its own right or be merged back with the subproject from which it originated. For example, the development of a product for a new operating system may start with the existing files for the first operating system as its base.
Also a branch of a tree, such as the project tree.


 build

The process of compiling, assembling, and linking all project files in proper sequence to produce the project’s product. Versions uses the build command provided as a project or subproject property to create the build.
Also an event in the life cycle of a product chosen to represent a quantifiable step in progress for a project. For example, a software product may deliver a new build every few days to the team members who test the product. Designating a build creates a set of non-permanent versions at the project level. Each version of a file in the build uses the name of the build as its label. When project security is enabled, only an administrator can designate a build. A build cannot be designated at the subproject level.


 build command

A command that you specify so that Versions can, with a single operation, compile, assemble, and link all project files in proper sequence to produce the project or subproject's product.


 build label

The name or number given to a specific build. StarTeam Workstation stores the build label in the version of each file in the project that was built.


check in
 check-in

The operation performed on a file that has undergone revision that stores the new file version in the Versions project vault.
Versions permits a number of individuals to work on a common set of files by allowing only one team member to revise a project file at a time. Check-in marks the end of one revision. The team member who checks in the file can keep it locked or release the file to others by unlocking it.


check out
 check-out

The operation that copies a version of a file from the Versions project vault to a team member’s working directory. A team member can check out a file with or without the intention to alter that file. Versions permits a number of individuals to work on a common set of files by allowing only one team member to revise a project file at a time. Locking the file marks the beginning of one author's revision.


 column header

The label or name for a column in lists that appear in the right pane of the Versions project window. Clicking the header initiates sort operations based on the values in that column.
To hide a column, locate the bar that follows the column header (and separates that header from the one that follows it). Drag the bar to the left edge of the column. When you release the mouse button, you should no longer see the header.


 command-line file

When you compare two files or versions using Versions, Versions sends a command-line file to Visual Diff containing the appropriate parameters. If there is no space for this file or no temp directory to create it in, an error message appears.


context menu
 context menu (or pop-up menu)

A menu that appears when you right-click an item in the project window. The menu's contents vary with the context (what has been clicked). In general, a context menu contains the most commonly used items from a related drop-down menu on the menu bar. In some cases, the items on the context menu are shortcuts. For example, if you select Check In from the context menu that appears in the files list, you bypass the Check In dialog.


 defect

A fault or error in a product. A suggested change or enhancement is also a defect.


 delete

To remove information from Versions databases. You can delete:

•	Projects. Deleting a project deletes the project database file (.stp) and the vault for that project. No one can be using the project database file at the time.

•	Project files and working files.

•	Versions of a file. To delete a file version, the file must be locked.

•	Audit entries. You can clear the entire log or delete everything up to a specified date.

•	Working files as part of removing a subproject or file from version control.

When project security is enabled, only an administrator can perform these operations. Anyone can delete non-project files from their working directories by selecting the file and pressing Delete.

See also remove from version control.


delta
 delta storage

A method of computing differences between progressive versions of a file.

Versions implements reverse deltas for text files, which means that only the latest version of the file is saved in its entirety. Delta storage reduces the disk space necessary to store the version information of a file by comparing new and previous versions of the file and storing only the differences.


 double-click

The action of rapidly depressing and releasing the primary mouse button twice. You double-click:

•	A project or subproject in the project tree to expand or collapse the branch for which that project or subproject is the root.

•	A file in the project tree or files list to open it.

•	A version in the history list to see its properties.

•	An entry in the audit log to see its properties.


 e-mail

An organized system for delivery of paperless, "electronic" messages, named for its similarities to the postal mail system. Versions provides advantages (such as mailing files and audit entries) for teams that use a MAPI-compliant e-mail system.


 file compression

A technique for reducing the size of a file by removing redundant information from it. Most disk files contain repetitions of common sequences of characters. Compression algorithms remove the additional occurrences of these sequences and save information that permits their restoration. By selecting compression of files, you may reduce vault space requirements as well as improve performance.


 files list

The list of files for the project or subproject, selected from the project tree, that is displayed when you select the Files tab. The list is further refined by the scope button and filter you select.


 filter

The criteria used to select a few items from among many. The Filter drop-down list box in the project window allows you to display only the files, or audit entries that are of interest.


 filtering

The technique of selecting a few items from among many by specifying criteria that eliminate unwanted items. For example, you can select only the files that need to be checked in.


 group band

The label that separates data with the same value in a given column from the data above it in the list. Depending on the column, group bands may appear in the project window after you click a column header to sort the data based on the value in that column. For example, time stamps are likely to be unique so no bands appear when that column is sorted in the files list. However, sorting the Ext. column groups files according to their extensions and displays group bands which make viewing and report generation easier.


 history list

The list of versions for the file selected from the project tree that is displayed when you select the History tab from the bottom of the project window’s right pane or from the File Properties dialog.


 keyword

Reserved words beginning and ending with a dollar sign ($). When used in a text file, Versions replaces them with the data that they represent. For example $Author$ is replaced by the name of the user who checked in the file.

 Related Topics


 keyword expansion

A technique used to insert information in a text file in which keywords are replaced by the data they represent. For example $Author$ is replaced by the name of the user who checked in the file.


scope button
 scope buttons

The buttons at the top of the right pane. Depending on the contents of the right pane, one or all of the buttons may be disabled.

  No Descendants	Displays information only for the item selected from the project tree.

  Immediate Descendants	Displays information for the selected item and any items attached to it.

  All Descendants	Displays information for the entire branch. This includes information about the selected item, its subprojects, and their files.


 lock

The process of making others aware of the fact that you are revising a file. Others can check out a file you have locked, but they cannot check it in unless they break your lock. When project security is enabled, only an administrator can break your lock.
Optionally, team members can have unlocked files marked read-only, which prevents them from making any changes to files that may be locked by others.
A file must be locked before you can check it in, delete it or one of its versions, change its number of maximum non-permanent versions, purge its non-permanent versions, or change a version from non-permanent to permanent or vice versa. When security is enabled, you must be an administrator (and lock the file) to perform any of the above except check-in.


 locker

The team member who has locked a file is known as its locker.


 MAPI

Acronym for Mail Application Programming Interface. A programming interface that permits an application to send and receive electronic mail via the Microsoft Mail messaging system or any other MAPI-compliant system.


 merge

The process of combining a working file with the latest checked-in version of that file or of combining a branched file with the root file from which it was branched. In either case, the combined file is placed in the user’s working directory where it can be inspected or revised before being checked in.


 milestone

An event in the life cycle of a product chosen to represent a significant step in progress, for example, the alpha, beta, or final release of a product. In Versions, a milestone designates a single set of permanent versions for the files in a project. Each version in the milestone has the same label. When project security is enabled, only an administrator can designate a milestone. Milestones cannot be designated at the subproject level.


 milestone label

The label applied to each version in a milestone.


non-permanent version
 non-permanent (also temporary or interim)

A designation applied to any version of a file included in a Versions project that has not been defined as permanent. The oldest non-permanent version is automatically deleted when the maximum number of versions is exceeded.

To purge a file of its non-permanent versions, change the status of a file version from non-permanent to permanent, or change the maximum number of non-permanent versions to be stored, the file must be locked. When project security is enabled, only an administrator can perform these operations.


 numeric

A value consisting of the valid digits 0-9.


omega
 omega storage

A method of file version storage in which all versions of a file are saved in their entirety. Omega storage eliminates the long processing times necessary to reconstruct complex binary files stored in delta or reverse delta format and can actually consume less disk space than other storage methods used on binary files.

Versions stores all binary files in omega format. You can also store text files in omega format. This is a time and often a space-saving decision for large, rapidly changing text files such as Windows help files (.rtf).


 owner

A Versions-maintained attribute of an audit entry. An audit entry’s owner is the project, subproject, or file receiving the action. Note that an owner is NOT an individual.


permanent version
 permanent

A designation applied to a specific version of a file included in a Versions project. Making a version permanent prevents Versions from deleting it from the project vault when the maximum number of non-permanent versions has been reached or when the file is purged. Permanent file versions can only be deleted using History · Delete.
To delete a version, or to change its status from permanent to non-permanent (or vice versa), the file containing that version must be locked. When project security is enabled, only an administrator can perform these actions.


 project

A set of related files comprising a single product under Versions version control.


 project database file

Also referred to as the project file. The database file, designated during the creation of a project, that stores project information. By default, it ends with an .stp extension. See also (but do not confuse with) project file.


 project file

A file under version control; therefore, a file that is in a Versions project. See also (but do not confuse with) project database file.


 project tree

The hierarchical display of a Versions project and its associated subprojects and files. The project tree is always displayed in the left pane of the project window.


 project window

The window in which an open project is displayed by Versions. It contains two panes. The left pane displays the project tree and the right pane displays the files, versions, or audit log entries associated with the project, subproject, or file selected from the project tree.


 purge

The deletion of non-permanent versions from a file. If only one version of a file remains, that version cannot be purged. The most recently checked-in version is also never purged.
To purge a file, the file must be locked. When project security is enabled, only an administrator can purge a file.


remove (from version control)
 remove from version control

To delete all information about a file or subproject from the project database file (.stp) and the vault. To remove a file, the file must be locked. When project security is enabled, only an administrator can perform either of these operations.


 right-click

The action of pressing and releasing the secondary mouse button. Since most mice are configured for right-handed operation, the left button (under the index finger) is the primary button and the right button (under the middle or ring finger) is the secondary button.


 security template

A set of privileges defined as a template so that users or groups can be assigned to that template on a subproject-by-subproject basis.


 secondary sort

Sorting items by group in a list that is already sorted (primary sort). For example a file list might be sorted by extension, then (in a secondary sort), sorted by name within groups of the same extension.
Click a column header to perform a primary sort. Right-click a second header to perform a secondary sort.


primary sort
 sort or primary sort

To place items in ascending or descending order in the right pane of the project window based on the value in the column whose label you click. Depending on the values in the column, the values are sorted numerically or alphanumerically. Click once to sort. Click a second time to change the sort order from ascending to descending or vice versa. The primary sort column’s header is underlined. Right-click to create a secondary sort.


 subproject

A set of related files comprising a discreet portion of a product under Versions version control.


 team member

Any of the project users. Sometimes used to denote a user that does not have administrator status.


 team list

The list of team members for the project. Select the Team tab to display the list and information about each team member.


 test command

A command that you specify so that Versions can perform, in proper sequence, an automated test procedure for a project or subproject's product.


text file
 text file or ASCII file

A file that contains only printable text characters, spaces, carriage returns, and sometimes tabs and an end-of-file marker, without any formatting codes.


 time stamp

Information maintained by Versions about files, versions and audit entries.

For files:	The date and time for the working file.

For file versions:	The date and time that the file was checked into Versions.

For audit entries:	The date and time that the event occurred.


 unlock

The process of releasing a locked file so that others can check it in.


 user

An individual identified to Versions and given access to one or more projects and their component subprojects and files. When project security is enabled, that access is protected by password. A user is also referred to as a team member.


 vault

A directory where versions of the files that are under version control are stored. This directory’s name ends with a .vlt extension and is a subdirectory of the directory where the project database file (.stp) is stored.


 vault file

A file in the project vault that stores versions of a project file.


version
 version or revision

A copy of a file stored in the project vault. One or more of these versions may exist.


 version attributes

Data stored for each version of a file under version control, including version number, time stamp, author, file size, permanent or non-permanent status, version label (if any), and reason for check-in.


 version control

Version control is the process of storing and tracking the various changes (versions or revisions) to one or more files. A version control system maintains the version history generated as the files evolve into their final forms.

The main advantage of using an automated version control system is fast, easy recall of previous versions. If you are on a network, Versions also provides a quick, easy-to-use method of obtaining versions of files being generated and maintained by other users working on a project with you.


 version control system

Application software to help manage multiple versions of the same file.


 version label

A version label provides a convenient method of identifying a version of a file by name. This is valuable when you are checking in a group of files that may need to be checked out together. When multiple files are involved, each file will generally have a different number of versions. By selecting a version label, you can check out all files related to a specific change by referencing that version label. Every version within a build or milestone has the same version label. These labels are also called build labels or milestone labels.

 Related Topics


 version number

The version number is an identification number assigned by Versions when a version is checked in. You can use this number to access the version. Versions uses it to determine if you need to check out versions of the files currently stored in your working directory.

 Related Topics


 Visual Diff

A companion program to Versions. Visual Diff compares two text files or two versions of one text file and shows the differences (if any) between them.


 working directory

The directory designated to hold the working copies of files that have been checked out of the Versions project vault. It is also the directory from which files are added to or checked in to a project or subproject.


 working file

A copy of a file under version control which has been checked out of the vault so it can be reviewed or edited. Versions copies working files to the designated working directory on a workstation. This is in contrast to the stored file versions that are located in the vault.


 workstation database

Stwork20a.db is the workstation database file. The database contains information about what versions of files are in your working directories and so forth. For example, Versions uses it to determine what needs to be checked in or out.


 workstation options

User-selectable choices for the behavior of Versions on a specific workstation.


$NoKeyword$


Use the menus
 Use the Versions menus

For your convenience, Versions has:

•	Drop-down menus accessed from the menu bar.

•	Context menus that appear when you right-click an item in the project tree, files list, history list, team list or audit log. Each context menu contains a subset of the items found on one of the drop-down menus.

In general, each item on a context menu is identical in functionality to the corresponding item on a drop-down menu. The exceptions are Add Files, Check In, and Check Out. When selected from a context menu (or from the toolbar), these three items bypass the dialogs. They use the defaults set for the workstation, a file, or a project. When you select the option from a drop-down menu, a dialog allows you to override the defaults. For example, if the workstation default specifies that a file be locked during the check out process, you can use the Check Out dialog to make sure a particular file is not locked.

The menus are:

Drop-down Menus	Context Menus
Project Menu	Project Context Menu
	Subproject Context Menu
	File (in Project Tree) Context Menu
Files Menu	Files List Context Menu
History Menu	History List Context Menu
Team Menu	Team List Context Menu
Audit Menu	Audit Log Context Menu
Options Menu
Window Menu
Help Menu


Project menu (on Versions menubar)
 Project menu

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

New...

Open...

Close

Delete...

Send Note To...

Properties...

Security Templates...

Subproject...

New...

Branch...
Delete...

Create Directory Structure.

Expand

Collapse

Build

Test

Designate Build...

Designate Milestone...

Recent Projects (1 to 4)

Exit


New... (item on Versions Project menu)
 New Project

To create a project:

•	Click New Project [image] on the toolbar.
Or,
Select Project · New....

Administrative Function

 Dialog Box Options

Project name
(Required.) Type a name for your project using a maximum of 228 characters, but do not use forward slashes (/), backward slashes (\), or exclamation points (!).

Properties
Allows you to set project properties.

Working directory
(Required.) Type the path to the working directory or browse to locate the directory.
Do not use Universal Naming Convention (UNC) pathnames or all users will be forced to use the same working directory. For example, the working directory c:\bigproj\working specifies a working directory on each user’s local c: drive, while the working directory \\domain\mydisk\working specifies that physical location for a single working directory shared by all team members.
If you specify a directory that does not exist, Versions can create the directory for you.

Browse...
Click to browse for the name of the working directory.

Force default working directory
Select to require every user to store working files on his or her workstation in the working directory specified above. For example, if the default working directory is C:\COOL PROJECT, all users store the working copies of the files attached to the root subproject in the C:\COOL PROJECT directory on their individual workstations.
Clear to allow each user to select a working directory for the project's working files.

Configure subdirectories as subprojects
Select so that Versions automatically makes subprojects of all the specified directory’s subdirectories. For example, if the working directory is C:\COOL PROJECT and has a subdirectory named COMPONENT1, Versions creates subprojects named COMPONENT1. Similarly subdirectories of COMPONENT1 becomes subprojects of COMPONENT1.
Clear to keep Versions from creating any subprojects at this time.

Force default working directory for subprojects
This check box is enabled only when you select Configure Subdirectories As Subprojects.
Select to require every user to store each subproject's working files on his or her workstation in the working directory specified by the default working directory and the path from it to the subdirectory. For example, if the default working directory is C:\COOL PROJECT and has a subdirectory named COMPONENT1, all users store the working copies of the files in the COMPONENT1 subproject in the C:\COOL PROJECT\COMPONENT1 directory on their individual workstations.
Clear to allow each user to select a working directory for each subproject's working files.

Security
Select to require a password for the project and to reserve certain functions for administrators only. Clear to allow anyone to access the files in the project.

Audit log
Select to generate audit entries about actions performed on the project, subprojects, files, and users. The entries appear in the audit log and audit trail.

Advanced...
Click to set more project properties.

Save new project using
Indicates the name and location for files related to this project.

File name (.stp)
(Required.) Type the name (with the extension .stp) for the project database file.

File path
Type (or browse for) the path to the project database file. If a directory in the path does not exist, Versions can create it for you.
Put the project database file in a network location that is accessible to all team members or in a public directory on your local workstation.
Versions creates the project vault, which stores versions of files, in this same location.

Browse...
Click to browse for the path for the project database file.

 Related Topics


Open... (item on Versions Project menu)
 Open

To open a project:

1.	Click Open Project [image] on the toolbar.
Or,
Select Project · Open....
The Open Versions Project dialog appears.

2.	Select the project database file (.stp) for the project to be opened.


Send Note To... (item on Versions Project menu)
 Send Note To

If mail is enabled for the project, you can send an e-mail note to any or all members of the team.

To send a note to team members:

•	Select Project · Send Note To....

 Dialog Box Options

Recipient list
Select the recipients from the list box.

Send Now
Click to send your selection now.

Goto Mail...
Click to open your MAPI-compliant e-mail package and add additional text to your message.


Close (item on Versions Project menu)
 Close

To close the current project:

•	Select Project · Close.


 Delete Project

To delete a project:

1.	Select Project · Delete....
The Delete Project dialog opens.

2.	Select the project database file (.stp) for the project to be deleted using the Drives, Directories, and File Name boxes. Then click OK.
The Administrator Verification dialog opens.

3.	Confirm project deletion by typing your password.
Versions deletes the project database file, the project vault, and all stored file versions. Working copies of files stored locally are not deleted.

Administrative Function


Properties... (item on Versions Project menu)
 Project/Subproject/File Properties

To review or change properties:

1.	Select a subproject or file from the project tree.

2.	Select Project · Properties... or press Alt+Enter.
The Project Properties, Subproject Properties, or File Properties dialog opens.

 Related Topics


SubprojectNew... (item on Versions Project menu)
 New Subproject

To create a subproject:

1.	From the project tree, select the subproject to which the new subproject will be attached.

2.	Click New Subproject [image] on the toolbar.
The New Subproject dialog opens.

Administrative Function

 Dialog Box Options

Subproject name
(Required.) Type a name for your project using a maximum of 228 characters, but do not use forward slashes (/), backward slashes (\), or exclamation points (!).

Working directory
(Required.) Type the path to or browse for the name of the working directory.
Do not use Universal Naming Convention (UNC) pathnames or all users will be forced to use the same working directory. For example, the working directory c:\bigproj\working specifies a working directory on each user’s local c: drive, while the working directory \\domain\mydisk\working specifies that physical location for a single working directory shared by all team members.
If you specify a directory that does not exist, Versions can create the directory for you.

Browse...
Click to browse for the name of the working directory.

Force default working directory
Select to require every user to store working files on his or her workstation in the working directory specified above. For example, if the default working directory is C:\COOL PROJECT, all users store the working copies of the files attached to the root subproject in the C:\COOL PROJECT directory on their individual workstations.
Clear to allow each user to select a working directory for the project's working files.

Configure subdirectories as subprojects
Select so that Versions automatically makes subprojects of all the specified directory’s subdirectories. For example, if the working directory is C:\COOL PROJECT and has a subdirectory named COMPONENT1, Versions creates subprojects named COMPONENT1. Similarly subdirectories of COMPONENT1 becomes subprojects of COMPONENT1.
Clear to keep Versions from creating any subprojects at this time.

Force default working directory for subprojects
This check box is enabled only when you select Configure Subdirectories As Subprojects.
Select to require every user to store each subproject's working files on his or her workstation in the working directory specified by the default working directory and the path from it to the subdirectory. For example, if the default working directory is C:\COOL PROJECT and has a subdirectory named COMPONENT1, all users store the working copies of the files in the COMPONENT1 subproject in the C:\COOL PROJECT\COMPONENT1 directory on their individual workstations.
Clear to allow each user to select a working directory for each subproject's working files.

Advanced...
Click to provide a build command, test command, and description.

 Related Topics


 Description tab (for subproject)

Use the Description tab to create or modify the description for a subproject.

 Dialog Box Options

Description
(Optional.) Provide a description for the subproject using a maximum of 255 characters.

 Related Topics


SubprojectBranch... (item on Versions Project menu)
 Branch Subproject

Use this dialog to branch, or diverge, the most recent version of each file in the subproject. For example, it may be time to start 2.0 of a product (based on the code for 1.7) even though 1.7 is still being maintained. You can merge branched subproject files that are ASCII text files at a later date. You cannot branch the root subproject.

Administrative Function

 Dialog Box Options

Branch name
Type a name for the branch.

Working directory
Type the path to its working directory or browse to locate the directory.
Do not use Universal Naming Convention (UNC) pathnames or all users will be forced to use the same working directory. For example, the working directory c:\bigproj\working specifies a working directory on each user’s local c: drive, while the working directory \\domain\mydisk\working specifies that physical location for a single working directory shared by all team members.
If you specify a directory that does not exist, Versions can create the directory for you.

Browse...
Click to locate a working directory.

Reference by
Identify which versions to use as the initial version in the branched subproject by selecting the appropriate option button.

Latest version	Selects the latest version.

Version label	Selects the version with the label you select from the drop-down list box.

As of	Selects the last version that was checked in before the specified date and time. The current date and time is the default.
To specify a date, use the calendar (available from the list box), the next and previous  month buttons, and the arrow keys.
To specify a time, type the time in the text box, then select the AM or PM option button.

Branch child subprojects
This check box is available only when all the child subprojects have working directories that are subdirectories of the selected subproject.
Select so that Versions automatically branches the selected subproject and its children based on the above criteria.
Leave this check box clear to branch only the selected subproject at this time.


SubprojectDelete... (item on Versions Project menu)
 Delete Subproject

Use this dialog to remove a subproject from version control. You can delete the working files as well.

Administrative Function

 Dialog Box Options

Subproject name
Displays the name of the current subproject (a maximum of 228 characters).

Delete vault files
Select to remove the files in the subproject from the vault. When unchecked, the files become attached to the deleted subproject’s parent.

Delete child subprojects
Select to delete child subprojects and remove their files from version control. When unchecked, the child subprojects become children of the deleted subproject’s parent.

Delete working files
Select to delete working files for the files specified by the above two check boxes.


SubprojectCreate Directory Structure (item on Versions Project menu)
 Create Directory Structure

When you check out files, the directories you need for those files are created on your computer automatically. However, if you need the directory structure only to create a file or two to check in (not to check out the files created by others), use Create Directory Structure.

To create the directory structure on your computer for the selected subproject:

•	Select Project · Subproject · Create Directory Structure.
Or,
Select Create Directory Structure from the context menu.

This creates all the directories required to reach the selected subproject from the root directory. It also creates all the subdirectories for the subprojects of the selected subproject. For example, suppose Source Code, Online Help, and User Manual are subprojects of the Fantastic Product project. If you select Fantastic Product, Create Directory Structure creates all the directories related to Fantastic Product on your computer. If you select Online Help, Create Directory Structure creates the directories needed to reach the working directory for Online Help. Then it creates all the directories for Online Help’s subprojects. It does not create directories for Source Code, User Manual, and their subprojects.


Expand (item on Versions Project menu)
 Expand

To expand a branch of the project tree to its complete depth:

1.	Select a subproject from the project tree.

2.	Select Project · Expand.


Collapse (item on Versions Project menu)
 Collapse

To collapse a branch of the project tree:

1.	Select a subproject from the project tree.

2.	Select Project · Collapse.


Build... (item on Versions Project menu)
 Build

To build the selected subproject using the specified build command:

•	Select Build [image] on the toolbar.
Or,

•	Select Project · Build.

Administrative Function


Test... (item on Versions Project menu)
 Test

To test the selected subproject using the specified test command:

•	Select Test [image] on the toolbar.
Or,

•	Select Project · Test.

Administrative Function


Designate Build... (item on Versions Project menu)
 Designate Build

To designate a build label for the specified version of each file in the project:

•	Select Project · Designate Build....

Administrative Function

 Dialog Box Options

Name
Type a name for the build.

Include versions based on
Select the appropriate option button.

Latest version	Uses the latest checked-in version of each file in the build.

As of	Uses the version of each file that was the latest version at the specified date and time. The current date and time is the default.
To specify a date, use the calendar (available from the list box), the next and previous month buttons, and the arrow keys.
To specify a time, type the time in the text box, then select the AM or PM option button.


Designate Milestone... (item on Versions Project menu)
 Designate Milestone

To designate a milestone label for the specified version of each file in the project:

•	Select Project · Designate Milestone....

Administrative Function

 Dialog Box Options

Name
Type a name for the milestone.

Include version based on
Select the appropriate option button.

Latest version	Uses the latest checked-in version of each file in the milestone.

As of	Uses the version of each file that was the latest version at the specified date and time. The current date and time is the default.
To specify a date, use the calendar (available from the list box), the next and previous month buttons, and the arrow keys.
To specify a time, type the time in the text box, then select the AM or PM option button.

Build	Uses the specified build.
(Type the build’s name into or select it from the combo box.)


1 to 4 (item on Versions Project menu)
 Recent Projects

To reopen a recently used project:

•	Select Project · <name of project database>.


Exit (item on Versions Project menu)
 Exit

To exit Versions:

•	Select Project · Exit.


 Project context menu

Select the project from the project tree and display the following context menu with a right-click.

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

New Subproject...

Create Directory Structure

Properties...


 Subproject context menu

Select a subproject from the project tree and display the following context menu with a right-click.

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

New Subproject...

Branch Subproject...
Create Directory Structure

Properties...


Files menu (on Versions menubar)
 Files menu

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

Open

Edit

Send To...

Add Files...

Check In...

Check Out...

Lock

Unlock

Maximum Versions...

Purge

Compare

Merge

Compress Vault File

Decompress Vault File

Delete...

Charts...

Reports...

Select All

Properties...


Open (item on Versions Files menu and context menus)
 Open

To open the working copy of a file:

1.	Select a file from the project tree or the files list.

2.	Select Open from the Files menu or a context menu.
Or,
Double-click the file name.
If the file is executable, it is run. Otherwise, the selected file appears in the application that Windows associates with it.


Edit (item on Versions Files menu and context menus)
 Edit

To edit the working copy of a file:

1.	Select a file from the project tree or the files list.

2.	Click Edit [image] on the toolbar.
Or,
Select Edit from the Files menu or context menu.
The file appears in Notepad or the text editor set as a workstation option.


Send (item on Versions Files, History, and Audit menus)
 Send To...

You can attach a version of a file to an e-mail message or send the text of audit entries via e-mail.

To send working files, stored versions, or audit entries:

•	Select Send To... from the Files, History, Audit, or a context menu.

 Dialog Box Options

Recipient list
Select the recipients from the list box.

Send Now
Click to send your selection now.

Goto Mail...
Click to open your MAPI-compliant e-mail package and add additional text to your message.


Add Files... (item on Versions Files menu)
 Add Files

To add files to a subproject:

1.	Select a subproject from the project tree.

2.	Select the Files tab at the bottom of the right pane.

3.	Select Files Not in Project from the drop-down list at the top of the files list.

4.	Select the files to be added from the files list.

5.	Select Files · Add Files....
The Add Files dialog opens.

 Dialog Box Options

Lock files
Select to lock or clear to leave files unlocked.

Permanent
Select to make this version of the added files permanent or clear to make the version non-permanent.

Delete working files
Select to delete or clear to leave copies of the files in the working directory.

Force omega
Select to use omega storage instead of delta storage for text files. Clear to use delta storage. (Once a text file has been stored using omega storage, it will always be stored using omega storage.)

Maximum versions
Set options for files based on their storage type: delta or omega.

Delta (text):
Select the appropriate option button for text files using delta storage.

Maximum	Stores up to 32,767 versions.

Limited	Stores the specified number of non-permanent versions.
Type a number in the text box.

Omega (binary):
Select the appropriate option button for binary or text files using omega storage.

Maximum	Stores up to 32,767 versions.

Limited	Stores the specified number of non-permanent versions.
Type a number in the text box.

File description

Prompt for description for each file
Select to be prompted for per-file descriptions or clear to use one description for all files.

File description
Description for all files when a prompt is not used. Use a maximum of 255 characters.

Version label
(Optional.) Type a label for the files you are about to add. Use a maximum of 32 characters.
(Use this if retrieving these files together will be important later.)


Check In... (item on Versions Files menu)
 Check In

To check in files:

1.	Select one or more files from the files list.

2.	Select Files · Check In....
The Check In dialog opens.

 Dialog Box Options

Duplicate OK
Select if it is OK to create a version that is identical to the previous one, ensuring that a new version will be stored for all selected files. Clear to reject a duplicate version.

Permanent
Select to make this version of the file a permanent version. Clear to make the version non-permanent.

Force omega
Select to use omega, rather than delta storage, for this file. This change is not just for this version, but for all future versions of this file. Clear to use the type of storage previously (or by default) specified for this file.

Delete working files
Select to delete the copy of the checked-in file in the working directory. Clear to keep the working file.

Keep files locked
Select to keep your lock on the checked-in file. Clear to unlock the file as part of the check-in process.

Reason for check-in

Prompt for reason to check-in for each file
Select to be prompted per file for a reason or clear to use one reason for all files.

Reason for check-in text
Description for all files when prompt is not used. Use a maximum of 20K characters.

Version label
(Optional.) Type a label for the files you are about to check in. Use a maximum of 32 characters.
(Use this if retrieving these files together will be important later.)

Show Defects>>
If you are using Version along with StarTeam Workstation, click to extend the dialog to display the defects associated with the files selected for check-in.
After the dialog extends, the name of the command button changes to <<Hide Defects.

<<Hide Defects
Click to hide the defects. The name of the command button changes to Show Defects>>.

Defects fixed
Select the defects that are fixed by the versions being checked in. Versions changes the status of each defect to Fixed for you and makes the defect’s author responsible for it once more.
You can double-click a defect to review or change its properties.


Check Out... (item on Versions Files menu)
 Check Out

To check out files:

1.	Select one or more files from the files list.

2.	Select Files · Check Out....
The Check Out dialog opens.

 Dialog Box Options

Reference by
Identify which versions to check out by selecting the appropriate option button.

Latest version	Checks out the latest version.

Version label	Checks out the version with the label you select from the drop-down list box.

As of	Checks out the last version that was checked in before the specified date and time. The current date and time is the default.
To specify a date, use the calendar (available from the list box), the next and previous  month buttons, and the arrow keys.
To specify a time, type the time in the text box, then select the AM or PM option button.

Lock
Select to lock the files. Clear to preserve the current status of each file.

Force check-out
Select to check out a version even if it is older than the copy currently in the working directory.


Lock (item on Versions Files menu)
 Lock

You must lock a file before you:

•	Check it in

•	Change its maximum number of versions

•	Remove it from version control

•	Delete one of its versions

•	Purge non-permanent versions from it

•	Change the status of one of its versions from permanent to non-permanent or vice versa

To lock files:

1.	Select one or more files from the files list.

2.	Select Lock from the Files menu or the context menu.


Unlock (item on Versions Files menu)
 Unlock

To unlock files:

1.	Select one or more files from the files list.

2.	Select Unlock from the Files menu or the context menu.


Maximum Versions... (item on Versions Files menu)
 Maximum Versions

To specify the maximum number of non-permanent versions:

1.	Select one or more files from the files list and lock them.

2.	Select Files · Maximum Versions....
The Maximum Versions dialog opens.

Administrative Function

 Dialog Box Options

Maximum versions
Set options for files based on their type of storage: delta or omega.

Delta (text):
Select the appropriate option button for text files using delta storage.

Maximum	Stores up to 32,767 versions.

Limited	Stores the specified number of non-permanent versions.
Type a number in the text box.

Omega (binary):
Select the appropriate option button for binary or text files using omega storage.

Maximum	Stores up to 32,767 versions.

Limited	Stores the specified number of non-permanent versions.
Type a number in the text box.


Purge (item on Versions Files menu)
 Purge

To delete non-permanent versions from vault files:

1.	Select one or more files from the files list.

2.	Select Files · Purge.
Permanent versions and the most recently checked in version are not deleted during a purge.
The history information for all deleted versions remains in the project database, and the deleted versions are dimmed in the file’s history display.

Administrative Function


Compare (item on Versions Files menu)
 Compare

To compare the working file with the most recent version:

1.	Select a file from the files list.

2.	Click Compare [image] on the toolbar.
Or,
Select Files · Compare.


Merge (item on Versions Files menu)
 Merge

You can merge a branched file with the current version of that same file in the main trunk, or vice versa. Also, if you have worked on a file that you forgot to lock, you can merge your working copy with the most recently checked-in version. In any case, the newly merged file overwrites the working file in your working directory.

To merge:

1.	Select a file from the files list.

2.	Select Files · Merge.


Compress Vault Files (item on Versions Files menu)
 Compress Vault File

Save space on the server or workstation that stores vault files by compressing those files.

To compress vault files:

1.	Select one or more files from the files list.

2.	Select Files · Compress Vault File.


Decompress Vault Files (item on Versions Files menu)
 Decompress Vault File

To decompress vault files:

1.	Select a file from the files list.

2.	Select Files · Decompress Vault File.


Delete... (item on Versions Files menu)
 Delete Files

Use this dialog to remove files from version control. At the same time, you can delete the files from the working directory.

To remove files from version control:

1.	Select files from the files list.

2.	Select Files · Delete... from the menu bar.

Administrative Function

 Dialog Box Options

Delete working files
Select to delete this file from the working directory as well.

You can delete files that are not under version control (using the Files Not In Project filter and Files · Delete.... However, you do not see this dialog, just a confirmation message, when appropriate.


Charts... (item on Versions Files, History, Team, and Audit menu)
 Charts

To display charts:

•	Select Charts... from the Files, History, Team, or Audit menus. For example, you can chart files by their sizes or audit entries by their types or events.

 Dialog Box Options

Charts
Select a type of chart from the list.

Chart description
Displays a description of the selected chart.

Chart information
Select the appropriate option button indicating which files, versions, users, or audit entries to use in the chart.

Currently selected	Only those selected.

Select all	The entire list.

Close
Click to stop creating charts and close the dialog.

Chart
Click to view the selected chart.


Reports (item on Versions Files, History, Team, and Audit menu)
 Reports

To generate reports:

•	Select Reports... from the Files, History, Team, or Audit menus. For example, you can generate a report about version history for a selected file.

 Dialog Box Options

Reports
Select a type of report.

Report description
Displays a description of the selected report.

Report information
Select the appropriate option button indicating which files, versions, users, or audit entries to use in the report.

Currently selected	Only those selected.

Select all	The entire list.

Close
Click to stop generating reports and exit the dialog.

Preview
Click to display the report on the screen.

Print
Click to print the report.

 Related Topics


Select All (item on Versions Files menu)
 Select All

To select all the files in the files list:

•	Select Select All from the Files menu or the context menu.

You can also select everything using Ctrl+/.


Properties (item on Versions Files menu or on context menu)
 File Properties

To review or modify the properties of a file:

1.	Select a file from the project tree or the files list.

2.	Select Properties... from the Files menu, Project menu, or a context menu. (You can also press Alt+Enter.)

•	Use the Working File tab to view information about the working file.

•	Use the Vault File tab to view information about the vault file.

•	Use the History tab to view the version history of this file.

•	Use the Defects tab to view the defects assigned to this file.

•	Use the Audit Trail tab to view the events that have been performed on this file.

Working File tab (for File Properties)

 Dialog Box Options

Name
Displays the name of the working file (a maximum of 255 characters).

Path
Displays the path that the working file would have or does have on your hard disk.

Exists
Displays Yes if the working file resides on your hard disk and No if it does not.

Size
Displays the size of the working file in bytes.

Time stamp
Displays the date and time of the working file.

Status
Displays status information. For example, the file may be up-to-date or need to be checked in or out.

Description
Displays a description of the file. You can modify the description if you have the file locked. Use a maximum of 255 characters.

 Related Topics


Vault File tab (of Versions File Properties)
 Vault File tab (of File Properties)

Use this dialog to view information about the vault file.

 Dialog Box Options

Name
Displays the name of the vault file (a maximum of 255 characters).

Size
Displays the size of the vault file in bytes.

Compressed
Displays Yes if the vault file is compressed and No if it is not.

Storage type
Displays the type of storage used for the file: delta or omega.

Latest version
Displays the number for the latest version stored in the vault file.

Locked by
Displays the name of the person who has locked the file or the words Not Locked.

Maximum versions
Allows you to reset options for this file (if you are an administrator and you have locked the file). Otherwise you can only view the information.

Maximum	Stores up to 32,767 versions.

Limited	Stores the specified number of non-permanent versions.
Type a number in the text box.

 Related Topics


History tab (of Versions File Properties)
 History tab (of File Properties)

Use this dialog to view this file’s version history. You can sort columns and use the context menu just as you can from the History tab on the project window.

 Dialog Box Options

The columns for the history list are:

Version #	Number Versions gave the version as it was checked in.

Time Stamp	Date and time of the version.

Author	Person who checked in the version.

File Size	Size of the version in bytes.

Reason for Check-In	Reason provided for checking in the version.

At the bottom of the dialog is information about what file the initial version of this file was branched from:

Branched from
Displays the name of the file from which this file was branched. Usually the name of both files is the same.

Version number
Displays the version number of the file from which this file was branched.

 Related Topics


Defects tab (of StarTeam Workstation File Properties)
 Defects tab

Use this dialog to view the defects assigned to this subproject or file. You can sort columns and use the context menu. However, the context menu contains only one menu item: Properties....

Two icons may precede each defect. One indicates its status; the other appears only if the defect is a priority.

 Dialog Box Options

The columns for the defects list are:

Defect #	Number Versions assigned to the defect when it was first submitted.

Status	Indication of the defect’s progress from open to resolved to verified to closed. This is referred to as a defect’s life cycle.

Priority	Indication that the defect is a [image] Priority or Not a Priority.

Severity	Seriousness of defect:	 High
 Medium
 Low

Responsibility	Person who is responsible for fixing the defect.

Synopsis	Short explanation of the defect.

Date Entered	Date and time the defect was submitted.

Build Tested	Build in which the defect occurs.

Build Addressed In	Build in which the defect is fixed.

Author	Person who submitted the defect.

Type	Type of defect:	 Defect
 Suggestion

Owner	Subproject or file to which the defect is attached.

 Related Topics


Files (in project tree) context menu
 File (in project tree) context menu

Select a file from the project tree and display the following context menu with a right-click.

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

Open

Edit

Send To...

Check In

Check Out

Lock

Unlock

Compare

Properties...


 Files list context menu

Select one or more files from the files list and display the following context menu with a right-click. Some menu items on the context menu, such as open and edit, are available only when you select a single file.

As you click each item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

Open

Edit

Send To...

Add Files

Check In

Check Out

Lock

Unlock

Compare

Select All

Properties...


Add Files (item on Versions Files context menu)
 Add Files

Adding files from the context menu uses the default settings for all add-files options. To change those settings as part of the add-files process, select FilesAdd Files....

To add selected files:

1.	Select a subproject from the project tree.

2.	Select the Files tab at the bottom of the right pane.

3.	Select the Files Not in Project filter from the Filter drop-down list box.

4.	Select files from the files list.

5.	Select Add Files from the files list context menu.


Check In (item on Versions Files context menu)
 Check In

Checking in files from the context menu uses the default settings for all check-in options. To change those settings as part of the check-in process, select FilesCheck In....

To check in a file:

1.	Select a file from the project tree.

2.	Select Check In from the context menu.


Check Out (item on Versions Files context menu)
 Check Out

Checking out files from the context menu uses the default settings for all check-out options. To change those settings as part of the check-out process, select FilesCheck Out....

To check out a file:

1.	Select a file from the project tree.

2.	Select Check Out from the context menu.


Lock (item on Versions Files context menu)
 Lock

You must lock a file before you:

•	Check it in

•	Change its maximum number of versions

•	Remove it from version control

•	Delete one of its versions

•	Purge non-permanent versions from it

•	Change the status of one of its versions from permanent to non-permanent or vice versa

To lock a file:

1.	Select a file from the project tree.

2.	Select Lock from the context menu.


Unlock (item on Versions Files context menu)
 Unlock

To unlock files:

1.	Select a file from the project tree.

2.	Select Unlock from the context menu.


Compare (item on Versions context menus)
 Compare

To compare the working file with the most recent version:

1.	Select a file from the project tree or files list.

2.	Click Compare [image] on the toolbar.
Or,
Select Compare from the context menu.


Check In... (item on Versions Files context menu)
 Check In

Checking in files from the context menu uses the default settings for all check-in options. To change those settings as part of the check-in process, select FilesCheck In....

To check in files:

1.	Select one or more files from the files list.

2.	Select Check In from the context menu.


Check Out... (item on Versions Files context menu)
 Check Out

Checking out files from the context menu uses the default settings for all check-out options. To change those settings as part of the check-out process, select Files · Check Out....

To check out files:

1.	Select one or more files from the files list.

2.	Select Check Out from the context menu.


History menu (on Versions menubar)
 History menu

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

Send To...

Check Out

Permanent

Not Permanent

Compare

Delete

Charts...

Reports...

Select All

Properties...


 History list context menu

Select a version from the history list and display the following context menu with a right-click.

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

Send To...

Check Out

Permanent

Not Permanent

Compare

Select All

Properties...


Check Out (item on Versions History menu)
 Check Out

To check out a specific version:

1.	Select the version from the history list.

2.	Select Check Out from the History menu or context menu.


Permanent (item on Versions History menu)
 Permanent

To make a specific version a permanent version:

1.	Select one or more non-permanent versions from the history list.

2.	Select Permanent from the History menu or context menu.


Not Permanent (item on Versions History menu)
 Not Permanent

To make a specific version non-permanent:

1.	Select one or more permanent versions from the history list.

2.	Select Not Permanent from the History menu or context menu.


Compare (item on Versions History menu)
 Compare

To compare two versions or to compare a single version with the working file:

1.	Select one or two versions from the history list.

2.	Click Compare [image] on the toolbar.
Or,
Select Compare from the History menu or the context menu.


Delete (item on Versions History menu)
 Delete

To delete specific versions:

1.	Select the versions to be deleted from the history list.

2.	Select History · Delete.
The history information for all deleted versions remains in the project database, and the deleted versions are dimmed in the file’s history display.

Administrative Function


Select All... (item on Versions History menu)
 Select All

To select all the versions:

•	Select Select All from the History menu or the context menu.

You can also select everything using Ctrl+/.


Properties (item on Versions History menu)
 Version Properties

To view and modify version information:

1.	Select a version from the history list.

2.	Select Properties... from the History menu or the context menu.
(You can also press Alt+Enter.)
The Version Properties dialog opens.

 Dialog Box Options

Version number
Displays the version number.

Date/Time
Displays the date and time stamp for the version.

Version size
Displays the size of the version in bytes.

Author
Displays the name of the user who originally put the file under version control.

Permanent
Select to make this version permanent. Clear to make it non-permanent.

Reason for check-in
Type or modify the reason for checking in this version of the file. Use a maximum of 20K characters.

Version label
Displays the labels for this version (if there are any).


Team menu (on Versions menubar)
 Team menu

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

New User...

New Group...

Delete...

Charts...

Reports...

Select All

Properties...


 Team context menu

Display the following context menu with a right-click in the team list.

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

New User...

New Group...

Select All

Properties...


New... (item on StarTeam Workstation Team menu)
 New User

To add a new user:

1.	Select New User.... from the Team menu or the context menu.
The New User dialog opens.

User tab

 Dialog Box Options

User name
Type the name the user will use to log on to this project. This is usually the user’s logon name for the network. Use a maximum of 32 characters. Select this name carefully, because it cannot be changed.

Full name
If you have configured the project to integrate with your MAPI-compliant mail system, type the user’s e-mail name exactly as it appears in the mail directory. Otherwise, use any full name for the user. Use a maximum of 50 characters.
When using Microsoft Exchange, the full name and the Exchange profile name should be the same. Otherwise Microsoft Exchange returns an error message each time the user logs on to the Versions project. If this occurs, create a new Exchange profile with the same name as the StarTeam user name.

Password
Type user’s password. Use a minimum of 6 and a maximum of 50 characters.
Passwords are case-sensitive.

Confirm
Retype user’s password.

Administrator
Select if this user has administrator privileges. Clear when the user is not an administrator.

Force password change
Select to require the user to change his or her password after the first (or next) log on. Clear it to allow users to change their passwords whenever they want to.

 Related Topics


New... (item on StarTeam Workstation Team menu)
 New Group

To add a new group:

1.	Select New Group.... from the Team menu or the context menu.
The New Group dialog opens.

Group tab

 Dialog Box Options

Name
Type the name of the new group.

Members
Displays the names of the members to be added.

Add…
Click to add members. From the Add Users dialog, select the users to be added to the group.

Remove
Click to remove the names of the selected users from the Members list box. Use this button if you added members to the group unintentionally.

 Related Topics


Delete... (item on Versions Team menu)
 Delete

To delete users and/or groups selected from the team list:

•	Select Team · Delete.

Administrative Function


Select All (item on Versions Team menu)
 Select All

To select all the users displayed in the team list:

•	Select Select All from the Team or context menu.

You can also select everything using Ctrl+/.


Properties… (item on Versions Team menu)
 Properties…

To display properties for the selected user or group:

•	Select Properties… from the Team or context menu.


Properties... (item on Versions Team menu)
 User Properties

To review or modify a user’s properties:

1.	Select a user from the team list.

2.	Select Properties... from the Team menu or the context menu.
(You can also press Alt+Enter.)
The User Properties dialog opens.

•	Use the User tab to view information about the user’s name and privileges. You can change your full name, but, using this dialog, but only an administrator can:

−	Add a user

−	Change a user’s full name, password, or administrator privileges

−	Force a password change

•	Use the Group tab to view or modify the list of groups to which the user belongs.

User tab

 Dialog Box Options

User name
Displays the name the user logs on to this project with. (This is usually the user’s logon name for the network.)

Full name
Displays the user’s full name. If the project is integrated with your MAPI-compliant mail system, the full name should be the user’s e-mail name, exactly as it appears in the mail directory.
When using Microsoft Exchange, the full name and the Exchange profile name should be the same. Otherwise Microsoft Exchange returns an error message each time the user logs on to the Versions project. If this occurs, create a new Exchange profile with the same name as the Versions user name.

Password
Passwords are case-sensitive and must contain at least six characters.
Displays asterisks.

Confirm
Displays asterisks.

Administrator
Indicates whether this user has administrator privileges.

Force password change
Indicates whether this user must change his or her password when next logging on.

 Related Topics


Group tab (for User Properties)
 Group tab

Use this dialog to review or modify the groups to which this user belongs.

 Dialog Box Options

Membership
Displays the groups to which this user belongs. Every user is automatically a member of the All Users group.

Add…
Click to add this user to an additional group. From the Add Groups dialog, select one or more groups.

Remove
Click to remove this user from membership in the selected group or groups.


(Group) Properties... (item on StarTeam Workstation Team menu)
 Group Properties

To review or modify a group’s properties:

1.	Select a group from the team list.

2.	Select Properties... from the Team menu or the context menu.
The User Properties dialog opens.

•	Use the Group tab to view or modify the list of group members.

Group tab

 Dialog Box Options

Name
Type the new name of the group.

Members
Displays the names of current members for this group.

Add…
Click to add additional members. From the Add Users dialog, select the users to be added to the group.
The Add Users dialog lists users who are not already in the group.

Remove
Click to remove the names of the selected users from the Members list box.


Audit menu (on Versions menubar)
 Audit menu

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

Send To...

Clear Log...

Charts...

Reports...

Select All

Properties...


 Audit log context menu

Display the following context menu with a right-click in the audit log.

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

Send To...

Select All
Properties...


Clear Log (item on Versions Audit menu)
 Clear Audit Log

To empty the audit log:

1.	Select the root subproject from the project tree.

2.	Select Audit · Clear Log....

Administrative Function

 Dialog Box Options

Clear following audit entries
Select the appropriate option button to clear all or only part of the log.

All
Empties the entire log.

As of
Deletes all the entries at or before the specified date and time. The current date and time is the default.
To specify a date, use the calendar (available from the list box), the next and previous month buttons, and the arrow keys.
To specify a time, type the time in the text box, and select the AM or PM option button.


Select All (item on Versions Audit menu)
 Select All

To select all the entries displayed in the audit log:

•	Select Audit · Select All.

You can also select everything using Ctrl+/.


Properties... (item on Versions Audit menu)
 Audit Entry Properties

To view the properties for an audit entry:

1.	Select an entry from the audit log.

2.	Select Properties... from the Audit menu or the audit log context menu.
(You can also press Alt+Enter.)
The Audit Entry Properties dialog opens.

 Dialog Box Options

Type
Displays the type of entry: information, warning, or error.

Event
Displays the name of the action that was performed.

Time stamp
Displays the date and time that the entry was made.

User
Displays the name of the user who performed the action.

Owner
Displays the name of the subproject or file affected by the action.

Description
Displays a complete description of the action.


 Options menu

As you click each menu item below, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

Workstation...


Workstation... (item on Versions Options menu)
 Workstation Options

To set options defining how Versions runs on your workstation:

•	Select Options · Workstation....
The Workstation Options dialog opens.

−	Use the Confirm tab to indicate what actions and messages need your confirmation.

−	Use the Defaults tab to set a variety of options for files checked in and out from your workstation.

−	Use the Display tab to set options affecting the appearance of the main window, splash screen, and refresh rate.

−	Use the Tools tab to specify a text editor.

Confirm tab

 Dialog Box Options

Delete/Remove
Select to confirm all deletions. Clear to have deletions occur without confirmation.

Move
Select to confirm all moves (such as dragging a file from one subproject to another). Clear to move files and so forth without confirmation.

Overwrite
Select to confirm any overwriting of files. Clear to have overwriting occur without confirmation.

Warnings
Select to allow Versions to display warnings. Clear to bypass them.

 Related Topics


 Window menu

As you click each menu item, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

Cascade

Tile Horizontally

Tile Vertically

Arrange Icons
Close All Charts
Close All Reports
Refresh
Open Windows


Cascade (item on Versions Window menu)
 Cascade

To overlap the project windows:

•	Select Window · Cascade.

You can see all of the topmost project window, but only the upper and left-edges of the others.


Tile Horizontally (item on Versions Window menu)
 Tile Horizontally

To arrange the project windows horizontally end-to-end:

•	Select Window · Tile Horizontally.


Tile Vertically (item on Versions Window menu)
 Tile Vertically

To arrange the project windows vertically end-to-end:

•	Select Window · Tile Vertically.


Arrange Icons (item on Versions Window menu)
 Arrange Icons

To realign any minimized project windows:

•	Select Window · Arrange Icons.


Close All Charts (item on Versions Window menu)
 Close All Charts

To close all chart windows:

•	Select Window · Close All Charts.


Close All Reports (item on Versions Window menu)
 Close All Reports

To close all report windows:

•	Select Window · Close All Reports.


Refresh (item on Versions Window menu)
 Refresh

To update displayed data:

•	Select Window · Refresh.


1 to 4 (item on Versions Window menu)
 Open Windows

To make a recently opened window active:

•	Select Window · <name of open window>.


 Help menu

As you click each menu item, a description of it appears in another help window. Make sure you can see both windows, then investigate, in succession, any menu items of interest.

Help Topics

How to Use Help

Tip of the Day...

About Versions...


Help Topics (item on Versions Help menu)
 Help Topics

To see the Versions help file:

•	Select Help · Help Topics.


How to Use Help (item on Versions Help menu)
 How to Use Help

To learn how to use help:

•	Select Help · How to Use Help.


Tip of the Day... (item on Versions Help menu)
 Tip of the Day

To learn about Versions, a tip at a time:

•	Select Help · Tip of the Day....

 Dialog Box Options

Tip
Displays a tip.

Next Tip
Click to see the next tip.

Previous Tip
Click to see the previous tip.

Show tips at startup
Select to show a tip every time you start Versions. Clear to see tips only when you select Help · Tip of the Day....


About (item on Versions Help menu)
 About Versions

To display release, copyright, and licensing information about Versions:

•	Select Help · About Versions....

 Dialog Box Options

Name, release number, and copyright date
Displays Versions information.

Build number
Displays the build number for the release.

This product is licensed to:
Displays the name and corporation of the licensee.

Serial number
Displays the serial number for licensing purposes.

System Info
For NT systems, displays the Windows Diagnostic dialog. Select topics from this dialog to display information about your system.


New Project (button on Versions toolbar)
New Project

To create a project:

•	Click New Project [image].


Open Project (button on Versions toolbar)
Open Project

To open a project:

•	Click Open Project [image].


New Subproject (button on Versions toolbar)
New Subproject

To create a subproject:

•	Click New Subproject [image].


Edit (button on Versions toolbar)
Edit

To edit the selected file in Windows Notepad or the text editor of your choice:

•	Click Edit [image].


Compare (button on Versions toolbar)
Compare

To compare two selected versions of a file:

•	Click Compare [image].


Send (button on Versions toolbar)
Send

To send files, versions, or audit entries.

•	Click Send [image].


Lock File (button on Versions toolbar)
Lock

To lock the selected files:

•	Click Lock [image].


Unlock File (button on Versions toolbar)
Unlock

To unlock the selected files:

•	Click Unlock [image].


Add Files (button on Versions toolbar)
Add Files

To add the selected files to the project:

•	Click Add Files [image].

Adding files with the Add Files button uses the default settings for all add-files options. To change those settings as part of the add-files process, select FilesAdd Files....


Check In (button on Versions toolbar)
Check In

To check in new versions of the selected files:

•	Click Check In [image].

Checking in files with the Check In button uses the default settings for all check-in options. To change those settings as part of the check-in process, select FilesCheck In....


Check Out (button on Versions toolbar)
Check Out

To check out the latest versions of the selected  files:

•	Click Check Out [image].

Checking out files with the Check Out button uses the default settings for all check-out options. To change those settings as part of the check-out process, select FilesCheck Out....


Build (button on Versions toolbar)
Build

To build the selected subproject using the build command:

•	Click Build [image].


Test (button on Versions toolbar)
Test

To test the selected subproject using the test command:

•	Click Test [image].


Help (button on Versions toolbar)
Help

To view Versions online help:

•	Click Help [image].


 Project Properties

To review or modify the selected project’s properties:

•	Select one of the tabs across the top of the dialog.

−	Use the Name tab to change the name, working directory, or other information about the project.

−	Use the Defaults tab to specify the number of versions to be stored and the use of e-mail, compression, and keyword expansion.

−	Use the Users tab to assign users and/or groups to security templates for the root subproject.

−	Use the Commands tab to create build commands and test commands for the project.

−	Use the Exclude tab to exclude certain types of files from the files list when using the Files Not In Project.

−	Use the Description tab to describe the project.

−	Use the Defects tab to view the defects attached to the project.

−	Use the Audit Trail tab to review events related to the project.

Name tab (for Project Properties)

 Dialog Box Options

Project name
Type a name for your project using a maximum of 228 characters.

Security
Select to enable or clear to disable project security. When project security is enabled, only project administrators can change project properties, break locks, manage team member information, modify the number of versions for a file, and perform delete operations.

Audit log
Select to generate audit entries about actions performed on the project, subprojects, files, and users. Clear to stop adding entries to the log.

Working directory
Select the option button that indicates whether you are using the default or alternative working directory. You might be required to use the default by your administrator. If so, the option buttons are disabled.

Default
Specifies the default working directory to be used when no alternative is allowed or, when allowed, no alternative is specified. Type the path to the default working directory or browse to locate the directory.
If you specify a directory that does not exist, Versions can create the directory for you.
Administrative Function

Browse...
Click to browse for the name of the default working directory.
Administrative Function

Alternative
Specifies the working directory to be used for this project on this workstation. Type the path to the working directory or browse to locate the directory.
If you specify a directory that does not exist, Versions can create the directory for you.

Browse...
Click to browse for the name of the alternative working directory.

Force default working directory
Select to require all users to use the default working directory for this project. Clear to allow users to specify alternative working directories.
Administrative Function

 Related Topics


 Subproject Properties

To review or modify the selected subproject’s properties:

•	Select one of the tabs across the top of the dialog.

−	Use the Name tab to change the name, working directory, or other information about the subproject.

−	Use the Users tab to assign users and/or groups to security templates for the root subproject.

−	Use the Commands tab to modify the build commands and test commands for the subproject.

−	Use the Exclude tab to exclude certain types of files from the files list when using the Files Not In Project.

−	Use the Description tab to edit the description.

−	Use the Defects tab to view the defects attached to the subproject.

−	Use the Audit Trail tab to review events related to the subproject.

Name tab (for Subproject Properties)

 Dialog Box Options

Subproject name
Type a name for your subproject using a maximum of 228 characters.

Working directory
Select the option button that indicates whether you are using the default or alternative working directory. You might be required to use the default by your administrator. If so, the option buttons are disabled.

Default
Specifies the default working directory to be used when no alternative is allowed or, when allowed, no alternative is specified. Type the path to the default working directory or browse to locate the directory.
If you specify a directory that does not exist, Versions can create the directory for you.
Administrative Function

Browse...
Click to browse for the name of the default working directory.
Administrative Function

Alternative
Specifies the working directory to be used for this project on this workstation. Type the path to the working directory or browse to locate the directory.
If you specify a directory that does not exist, Versions can create the directory for you.

Browse...
Click to browse for the name of the alternative working directory.

Force default working directory
Select to require all users to use the default working directory for this subproject. Clear to allow users to specify alternative working directories.
Administrative Function

 Related Topics


Audit Trail tab (of Project/Subproject Properties)
 Audit Trail tab

Use this dialog to view the events that have been performed on this subproject or file. You can sort columns and use the context menu just as you can from the Audit tab on the project window. However, the context menu contains only one menu item: Properties....

 Dialog Box Options

The columns for the audit trail are:

Type	The type of action:
 Information, for each normal project activity, such as adding a subproject to a project.
 Warning, for non-critical abnormal project activity.
 Error, for critical abnormal project activity.

Event	 Name of the action, such as New Project or New Subproject.

Time Stamp	Date and time of the action.

User	 Person performing the action.

Description	Description of the action.

Owner	File or subproject receiving the action.

 Related Topics


 Defaults tab (for project)

Use this dialog to set or modify options for the project. You can override these default settings for individual files as you add them to the project or, later, by modifying their file properties.

 Dialog Box Options

Maximum versions
Set options for files based on their type of storage: delta or omega.

Delta (text):
Select the appropriate option button for text files using delta storage.

Maximum	Stores up to 32,767 versions.

Limited	Stores the specified number of non-permanent versions.
Type a number in the text box.

Omega (binary):
Select the appropriate option button for binary or text files using omega storage.

Maximum	Stores up to 32,767 versions.

Limited	Stores the specified number of non-permanent versions.
Type a number in the text box.

Time stamp working file with check-out time
Select to stamp working files with the time the version is copied to the working directory.
Clear so that working files retain the time stamp of the copied versions.
(The difference is whether the working file appears to be more recent than the copied version immediately or only after it has been updated.)

Use mail
Select to use a MAPI-compliant mail system from within Versions. For example, if you are logged on to e-mail, others are notified if you break their locks on files.

Keyword expansion
Select to use keywords in your text files. The keywords will be replaced with information stored by Versions. For example, $Author: JIsenbarger$ is replaced with the name of the user who checked in the version.

Settings
Click this button to create a list of file extensions and prefixes to be used with $Log:     28  05/15/97    JIsenbarger     fixed indexes    27  04/03/97    JIsenbarger         26  03/07/97    JIsenbarger     Branch Child Subprojects update    25  03/02/97    JIsenbarger     change property page to dialog    24  02/21/97    JIsenbarger     changed 2K to 20K for reason for checkin length    23  02/12/97    JIsenbarger     removed 2.0s    22  02/11/97    JIsenbarger     update for 2.1    21  12/13/96    JIsenbarger         20  12/13/96    BFlynn          Added $NoKeywords$    19  12/04/96    JIsenbarger         18  11/25/96    JIsenbarger         17  11/25/96    JIsenbarger         16  11/24/96    JIsenbarger         15  11/24/96    JIsenbarger         14  11/17/96    JIsenbarger         13  11/17/96    JIsenbarger         12  11/17/96    JIsenbarger         11  11/15/96    JIsenbarger         10  11/15/96    JIsenbarger         9   10/31/96    JIsenbarger         8   10/29/96    JIsenbarger         7   10/28/96    JIsenbarger         6   10/27/96    JIsenbarger         5   10/26/96    JIsenbarger         4   10/25/96    JIsenbarger         3   10/11/96    JIsenbarger         2   10/09/96    JIsenbarger         1   09/25/96    JIsenbarger     Initial Version$, the only multiline keyword. Usually a prefix contains the characters that indicate that a line is a comment. For example, in a .bat file, the prefix would be “rem”. You create the list using the Keyword Settings dialog.

Use compression
Select to compress all the files stored in the vault.

Force check-in reason
Select to require users to provide a reason for check in—even when they click the Check In button on the toolbar or select Check In from a context menu.

 Related Topics


 Keyword Settings

Use this dialog to create a list of file extensions and prefixes to be used with $Log:     28  05/15/97    JIsenbarger     fixed indexes    27  04/03/97    JIsenbarger         26  03/07/97    JIsenbarger     Branch Child Subprojects update    25  03/02/97    JIsenbarger     change property page to dialog    24  02/21/97    JIsenbarger     changed 2K to 20K for reason for checkin length    23  02/12/97    JIsenbarger     removed 2.0s    22  02/11/97    JIsenbarger     update for 2.1    21  12/13/96    JIsenbarger         20  12/13/96    BFlynn          Added $NoKeywords$    19  12/04/96    JIsenbarger         18  11/25/96    JIsenbarger         17  11/25/96    JIsenbarger         16  11/24/96    JIsenbarger         15  11/24/96    JIsenbarger         14  11/17/96    JIsenbarger         13  11/17/96    JIsenbarger         12  11/17/96    JIsenbarger         11  11/15/96    JIsenbarger         10  11/15/96    JIsenbarger         9   10/31/96    JIsenbarger         8   10/29/96    JIsenbarger         7   10/28/96    JIsenbarger         6   10/27/96    JIsenbarger         5   10/26/96    JIsenbarger         4   10/25/96    JIsenbarger         3   10/11/96    JIsenbarger         2   10/09/96    JIsenbarger         1   09/25/96    JIsenbarger     Initial Version$, the only multiline keyword. Usually a prefix contains the characters that indicate that a line is a comment. For example, in a .bat file, the prefix would be “rem”.

 Dialog Box Options

Log line prefixes

New

File extension
Type an extension to add to the list.

Line prefix
Type a prefix that will appear in each line of the $Log:     28  05/15/97    JIsenbarger     fixed indexes    27  04/03/97    JIsenbarger         26  03/07/97    JIsenbarger     Branch Child Subprojects update    25  03/02/97    JIsenbarger     change property page to dialog    24  02/21/97    JIsenbarger     changed 2K to 20K for reason for checkin length    23  02/12/97    JIsenbarger     removed 2.0s    22  02/11/97    JIsenbarger     update for 2.1    21  12/13/96    JIsenbarger         20  12/13/96    BFlynn          Added $NoKeywords$    19  12/04/96    JIsenbarger         18  11/25/96    JIsenbarger         17  11/25/96    JIsenbarger         16  11/24/96    JIsenbarger         15  11/24/96    JIsenbarger         14  11/17/96    JIsenbarger         13  11/17/96    JIsenbarger         12  11/17/96    JIsenbarger         11  11/15/96    JIsenbarger         10  11/15/96    JIsenbarger         9   10/31/96    JIsenbarger         8   10/29/96    JIsenbarger         7   10/28/96    JIsenbarger         6   10/27/96    JIsenbarger         5   10/26/96    JIsenbarger         4   10/25/96    JIsenbarger         3   10/11/96    JIsenbarger         2   10/09/96    JIsenbarger         1   09/25/96    JIsenbarger     Initial Version$ entry in a file with the corresponding extension. Use a maximum of 32 characters.

Add
Click to add your extension and prefix to the list.

File ext./Line prefix list box
Displays the current list of file extensions for which you defined prefixes.
To add an entry to the list, type an extension and prefix in the appropriate text boxes, then click Add.
To remove an entry from the list, select it then click Remove.

Remove
Click to remove the selected file extension/line prefix combination from the list.


 Users tab

Administrative Function Use this dialog to set, review, or modify security for the subproject. You can select any existing security template and add groups or individual users to it. However, each group or user can be assigned to only one template for this subproject.

If a user ends up assigned more than once, it is because the user:

•	Is a member of more than one assigned group

•	Was assigned both as a group member and as an individual user

In such cases, the user has the combined privileges of all assigned templates.

You can modify templates whether security is enabled or disabled, but your modifications do not go into effect until security is enabled.

 Dialog Box Options

Authorized Users

Template
Select a template to add users to (or ignore this drop-down list box).

User or Group Name
Displays the groups and users currently assigned to templates for this subproject. After the name of each user or group is the template to which the user or group is assigned.

Add…
Click to add users or groups to the selected template. Then the Add Users dialog lists the names of the users or groups that have not yet been assigned to a template for this subproject.

Remove
Click to remove the selected users and/or groups from the template to which they are assigned.


 Commands tab

Use the Commands tab to specify build command and test commands for a subproject.

 Dialog Box Options

Build command
Type or browse for a build command using a maximum of 1024 characters. For example, the command c:\online help\hcw nproduct would build a Windows help file named nproduct.hlp.

Browse...
Click to browse for a build command.

Test command
Type or browse for a test command using a maximum of 1024 characters.

Browse...
Click to browse for a test command.

 Related Topics


 Exclude tab

Use the Exclude tab to exclude certain types of files from the files list when using the Files Not In Project filter. For example, you may want to use version control for .rtf files, but not for .doc files, in a help subproject. Therefore, you exclude *.doc from the help subproject using this dialog. Then, when you add files to the project using the Files Not In Project filter, .doc files never appear.

Exclude lists apply only to the specified subproject. Exclusions are not inherited by subprojects at lower levels in the project tree.

 Dialog Box Options

Use exclude list
Select to use or clear to stop using the exclude list.

Exclude list
A list of filenames (using wildcards, for example, *.doc) separated by semicolons or commas.

 Related Topics


 Enter Description

Use this dialog to provide a description of the specified file.

 Dialog Box Options

File name
Displays the name of the file.

File description
Type a description of the file. Use a maximum of 255 characters.


 Enter Reason

Use this dialog to provide a reason for checking in the specified file.

 Dialog Box Options

File name
Displays the name of the file.

Reason for check-in
Type a reason for checking in the file. Use a maximum of 20K characters.


 Log On

Use this dialog to log on to a subproject.

 Dialog Box Options

User name
Type your user name. Use a maximum of 32 characters.
If security is disabled, User Name is the only text box on this dialog. In that case, logging on to a project adds you as a project member with the log in name you have specified. Select your name carefully, because it cannot be changed.
When using Microsoft Exchange, the full name and the Exchange profile name should be the same. Otherwise Microsoft Exchange returns an error message each time you log on to the Versions project. If this occurs, create a new Exchange profile with the same name as your Versions user name.

Password
Type the password that allows you to access the files in this subproject.
If security is disabled, you are not asked for a password. If security is enabled later, any user without a password is given a blank password.


 Defaults tab (for workstation)

Use the Defaults tab to set a variety of options for files checked in and out from your workstation.

Project and subproject options are usually set by the project administrator.

 Dialog Box Options

Lock files on check-out
Sets a default for the check-out process on your workstation that you can override as you check out files. Select to lock the files being checked out so that you can modify them. Clear to copy files to the working directory without changing their current lock status.

Keep files locked on check-in
Sets a default for the check-in process on your workstation that you can override as you check in files. Select to discourage others from modifying your files by retaining your locks on them. Clear to have files become unlocked automatically.

Delete working files on check-in
Sets a default for the check-in process on your workstation that you can override as you check in files. Select to keep your working directory free of files you have checked in. Clear to leave working copies in the working directory.

Mark unlocked working files read-only
Select to assign the read-only file attribute to unlocked files in your working directory. Then as you lock, unlock, check-in, or check-out versions, the corresponding working files become read-only or read/write (as appropriate). This prevents you from unintentionally modifying an unlocked file.
Unchecking this option does not immediately change the read-only status of any unlocked working files. File status changes only as part of a Versions operation, such as check-out. NOTE

Edit .bat and .cmd on double-click
Select to edit .bat and .cmd files when you double-click their filenames. Clear to execute them with a double-click.

 Related Topics


Note

To make all your working files for a project read-only (if the corresponding project file is unlocked):

1.	Select the Mark Unlocked Working Files Read-Only check box.

2.	Check in your latest files for the project.

3.	Empty your working directories.

4.	Check out all of the project’s files.


 Display tab (for workstation)

Use the Display tab to set options affecting the appearance of the main window and splash screen.

 Dialog Box Options

Reset scope selection on change
Select to revert to the No Descendants scope button whenever you change subprojects or tabs. This saves you the time Versions would take to scan the files associated with the selected subproject’s descendants.
Clear so that no automatic changes are made to the scope buttons.

Restore projects at startup
Select to reopen all the projects that were open when you exited Versions.

Display splash screen
Select to display the splash screen at start up. Clear to bypass the splash screen.

Display toolbar
Select to display the toolbar. Clear to hide it.

Display status bar
Select to display the status bar. Clear to hide it.

Automatic refresh rate
Type the number of minutes between automatic refreshes. The range is from 1 to 90 minutes. If the refresh interval for Versions is less than the time-out interval for your screen saver, the screen saver will not run while Versions is open.
Use 0 to stop automatic refreshes from occurring. (The default is 30 minutes.)

 Related Topics


 Bypass the Splash Screen

You can set a workstation option (Display Splash Screen) to bypass the splash screen.


 Tools tab (for workstation)

Use the Tools tab to specify a text editor to be used whenever you edit text files.

 Dialog Box Options

Text editor
Type or browse for the path to a text editor.

Browse...
Click to browse for a text editor.

 Related Topics


 Project Security Templates

Use this dialog to create security templates or to modify the privileges they allow.

 Dialog Box Options

Template
Select an existing template to be modified.

New...
Click to create a template.

Remove
Click to delete the selected template from the project and, therefore, from all subprojects simultaneously.

Access
Select the appropriate privileges by selecting their check boxes:

Add
Allows users to add files to the subproject.

Read
Allows users to check out files from the subproject.

Modify
Allows users to check files in and out of the subproject. (Selecting this check box automatically selects the Read check box.)

Delete
Allows user to delete files from the subproject.


Templates
 Template

Use this dialog to create a new template.

 Dialog Box Options

Name
Type the name of the new template.


 Print Setup

Use this dialog to specify the printer, the size and orientation of the paper, etc.

 Dialog Box Options

Printer
Select one of the connected printers. (Use the Network... button to connect to additional printers.)

Form
Select another form or paper size. For example, you may want to change from letter to legal size.

Orientation
Select the appropriate option button.

Portrait	Vertical orientation; printing each line across the width of the page.

Landscape	Horizontal orientation; printing each line across the length of the page.

2-Sided Printing
Select the appropriate option button.

None	One-sided printing only.

Long Side	Prints on two sides, suitable for binding the pages along the side, like a book.

Short Side	Prints on two sides, suitable for binding the pages along the top, like a notepad.

More...
Click to select even more options from the Advanced Document Properties dialog.

Network...
Click to connect to another printer on the network using the Connect to Printer dialog.
The printer’s name will then appear in the Printer drop-down list box.


Use the report window's toolbar
 Use the report window’s toolbar

The toolbar for the report window allows you to:

•	Move from page to page through the report

•	Print the report, save it as a file, or mail it

•	Zoom in on the report

•	Read status information about the number of pages and items (such as files) included in the report

Click each part of the toolbar to see a brief description:


 Go To the First Page

Click to go to the beginning of the report.


 Return To the Previous Page

Click to return to the previous page of the report.


 Go To the Next Page

Click to go to the next page of the report.


 Go To the Last Page

Click to go to the end of the report.


Page information

Indicates the current page number and the total number of pages.


Item information

Indicates the number of items (such as files) used in the report out of the total number of items available as well as the ratio and percentage between them.


 Print

Click to print the report.


 Save Report as File

Click to save the report as a file.


 Send Report

Click to attach the report to e-mail.


 Cancel

This button is disabled in Versions.


 Zoom

Click to switch among two or three of the following views:

•	Normal width
You may have to scroll horizontally and vertically to see rest of the page.

•	Adjusted width (to fit the pageÕs complete width in the window)
The adjusted width view is not displayed if the window is large enough to show the pageÕs complete width in normal width.
You may have to scroll vertically to see the rest of page.

•	Adjusted height (to fit the pageÕs complete height in the window)


 Administrative Function

When project security is enabled, this is an administrative function. You must be a designated project administrator to perform it.


 Versions overview

Versions provides version control, a team list and an audit log. It allows you to create charts and reports about files, versions, and so forth. It also incorporates e-mail so that you can send files or versions to others. Versions sends e-mail to users to let them know when anyone breaks their locks on files. This combination:

•	Allows you to store everything related to the product in one place using just one application. For example, you can store source code, marketing requirements documents, online help files, and manual chapters all in one convenient project tree. In addition, the information is automatically filtered based on the subproject or file you select.

•	Improves teamwork on product development.

•	Keeps track of who did what when.

•	Uses the latest technology. Versions is targeted for Windows 95 and Windows NT to take advantage of 32-bit technology.

 Related Topics


 What is version control?

If you think that you have never used version control, you are probably wrong.

Maybe you used different filenames for different versions of the same document. For example, you might have named a file rpt0908.doc on September 8th and changed it to rpt0910.doc on September 10th—just so you could keep both versions. This is version control. It allows you to return to the September 8th version if the changes you made September 10th become obsolete.

Many popular software packages maintain a single extra copy of your work in a .bak file. This “backup” file contains the previously saved copy of your work so you always have access to the two latest versions of the file. This scheme has proven valuable to most people at one time or another. It allows you to recover the previous version of a file if you accidentally delete or damage the original. This, too, is version control.

If you are new to version control, this introduction gives you the basics. If you are not new to version control, it explains what features Versions offers and how they are implemented.

Versions allows you to maintain any number of previous versions in a special directory called the vault. As far as you are concerned, the file has only one name. However, Versions gives each copy a unique name and keeps track of these unique names for you. The vault is a directory on your hard drive or, more likely, a network drive. Other than being sure never to delete the directory or any file in it, the vault is of no concern to you.

 Related Topics


 Organize the project hierarchy

Versions provides more than just version control of individual files. It allows you to organize entire groups of related files—files for source code, documentation, marketing materials, pricing spreadsheets, and so forth.

Versions provides a project window that displays the files in a hierarchy. Usually the project administrator creates subprojects for a project. Then you and other users create files to add to those subprojects. These form a tree consisting of the root subproject, its subprojects, and the files in those subprojects. You select a file from the project tree when you want to view the file’s history, which lists the versions of that file currently stored in the vault.

The following figure represents the StarDraw project.

The open folder at the top is the root subproject. The folders within it, such as those named Beta Materials and Design Documents, are subprojects. The page icons (in front of IPFRAME.CPP and IPFRAME.H) represent individual files.

Adding a file puts the initial copy of that file in the vault. That copy can be checked out from the vault by people who need to read it or change it. Before you check out a file to change it, you should lock it. A special icon indicates whether a file is locked. When others see that icon, they know that someone is working on the file and they should not work on it themselves until is becomes unlocked.

NOTE:	Versions has a merge feature for ASCII text files, but it is always best to work only on files that you personally have locked.

 Related Topics


Project view of Versions
 Project view

What Is a Versions project? A project is a way to group related files and place them under version control. For example, if you are developing a software product, the files that contain the product’s functional specification, marketing requirements document, source code, test suites, etc. can be stored in subprojects. Putting a file under version control gives the team the opportunity to share work in progress, return to an earlier version of the file, maintain multiple versions that are used for different clients, and avoid data loss. Remember that version control is not a substitute for regular backups.

Although you may organize projects in nested directories and subdirectories, Versions does not limit the project to those files stored together (hierarchically) on your hard disk. Project directories may be located anywhere within your environment. All directories associated with a Versions project are displayed together, allowing convenient access to all your project resources, no matter where they are physically located.

Advantages of projects:  In addition to version control, you can:

•	Limit a project to specific password-protected users.

•	Monitor it for activity using the audit log. For example, the log indicates when you create a project, remove a subproject from version control, purge a file, or add a user.

•	Quantify the accumulated data using charts and reports.

•	Branch and merge subprojects.

Where is the data stored? When you create a project, you provide the name of a project database file (usually with the extension .stp) that will store information about the versions, team members, and the audit log. The versions of the files you have placed under version control go into a project vault. Versions uses the name of the project database file (but this time with the extension .vlt) to create the directory in which file versions are stored. The vault is in the same directory as the project database file. Do not delete these files or modify them in any way.

Compression: If you set the compression option, Versions will compress all the file versions as they are stored in the vault. You can override the project’s file compression defaults on a file-by-file basis using Files · Compress Vault File or Files · Decompress Vault File.

 Related Topics


 Use working files

When you check out a file, Versions copies the desired version of that file from the vault to your workstation's hard drive. This is called the working file and has the filename that appears in the project hierarchy.

To make working files easy to locate, Versions allows administrators to specify directories to store working files on every user's hard drive. The project itself and each subproject has such a directory, called its default working directory. Often the working directories form a hierarchy similar to the project hierarchy. For example, the following figure compares the StarDraw project hierarchy (in a Versions project window) with its folder/directory structure on your hard drive (in an Explorer window).

Notice that these hierarchies are almost identical. The Beta Materials subproject maps to the Beta Materials directory, and the Design Documents subproject maps to the Design Documents directory. Notice the differences: The External Resources subproject maps to the res directory, and the On-line Help subproject maps to the hlp directory. In this case, the only difference is that more descriptive names are given to the subprojects than to their corresponding working directories. Also, because both subprojects and directories are in alphabetical order, the order for External Resources and On-line Help is different than the order for the hlp and res directories.

However, a project hierarchy does not have to map so nicely onto the hard drive. For example, the Source Code subproject could map to C:\Source Code while the Beta Materials subproject could map to C:\External Testing\StarDraw Beta\Beta Materials.

In addition, Versions allows you to specify working directories on a per workstation basis. Depending on what options are set for the project, you can tell Versions to ignore the default working directory and put files from the Beta Materials subproject in C:\StarDraw Beta on the workstation in your office and in D:\Beta Materials on your laptop.

The important things to remember are that the versions are stored in the vault and copied to your hard drive. The location to which they are copied depends on the default working directory specified for the subproject or on the working directory you specify for that subproject on your workstation. You cannot change or even look at a file until a version of it has been copied to your hard drive.

The version you read or change is always the working file on your hard drive. This is why it is so important not to work on files that you have 1) not locked and 2) not checked out the most recent version of. Suppose you checked out the most recent version of a file, but didn’t lock it and didn’t work on it for several days. Your working file could be two versions older than the most recent one. If you change it and then check it in, the changes made by your coworkers would be missing from the most recent version and lost unless they are retrieved from the earlier versions. To protect your work and that of your coworkers, Versions only allows you to check in files that you have locked. It warns you if your working file is not the most recent version.

 Related Topics


 Create new versions

Checking in a file adds another version of that file to the vault. You check it in (and perhaps unlock it for others):

•	When you are done working on it.

•	When you have made a significant number of changes and want to save them.

•	To be sure that you can go back to the file in its current state later. (Usually before you make some drastic changes that you might not want to keep.)

Even with the space-saving measures that Versions can take, the vault could become very large if you saved every single version of each file. Therefore, Versions allows you to limit the number of versions to be kept. For example, suppose you or your administrator decide to keep only 10 versions of a particular file. Then when the 11th version is added, the first (the oldest) is deleted. Because you might want to save some versions, regardless of their age, Versions allows you to mark any such versions as permanent. Permanent versions are never deleted. Nor are they counted among the 10 versions to be kept, in this example. That means you keep all the permanent versions in addition to the specified number of non-permanent versions.

 Related Topics


File view of Versions: General information
 File view: General information

When a file is under version control, Versions maintains the information needed to recreate any stored version of that file as a working file.

Storage method:  Versions uses either omega or delta storage depending on the type of file.

Binary files:  Versions always stores each version in its entirety (omega storage).

Text (ASCII) files:  By default, Versions stores the latest version in its entirety. For all other stored versions, only the differences between one version and the previous are saved (reverse delta storage). For large text files that change rapidly, specifying omega storage may shorten the check-in time significantly because there is no need to check for differences. Once a text file has been stored using omega storage, it will always be stored using omega storage.

Compression:  With either method, the data that is stored can be compressed.

How much Is stored:  Versions stores all versions of the file that you designate as permanent. In addition, it stores a specific number of the most recent non-permanent versions. For example, suppose the maximum is 10 non-permanent versions. When the 11th non-permanent version is checked in, the first non-permanent version is automatically deleted.

You set a default maximum for non-permanent versions of any project file as a property at the project level, but you can override that maximum for specific files as you add them to the project or, later, by changing their file properties.

You can perform additional clean-up by deleting permanent versions or by purging all non-permanent versions of a file from the vault. However, one version must always be left in the vault. To get rid of all versions, remove the file from your Versions project.

History and audit log:  Versions preserves historical information about each version and logs information about actions performed at the file level (and other levels). For example, the audit log indicates when and by whom a file is added to a project, checked in, and purged of non-permanent versions.

 Related Topics


File view of Versions: Use a file under version control
 File view: Use a file under version control

To place a file under version control, add it to a project.

Adding a file:  The file must be in the working directory for either the project or one of its subprojects. If your computer does not have the correct directory, create it using Project · Subproject · Create Directory Structure.... Then move the file to be added to the correct directory.

Adding the file stores a copy of the working file (the version of the file in the working directory) as the first version in the vault. This means that you can delete the working file without losing any data. Versions recreates that version for you any time you check it out.

Checking out a version:  Checking out a version copies that version of the file to a working directory.

Check out a version to be sure that you have the latest or a specific version to work on. For example, you may need the changes made to the file by a team member or you may have deleted the working file earlier, just to save space on your hard drive.

If you intend to make changes to the file, you should lock it as part of the check-out procedure. The lock makes your intention clear to others. Besides, the file must be locked before you can check it back in.

The defaults for your workstation options indicate how you want to check files in and out. However, you can override these defaults for specific files by selecting Files · Check In... or Files · Check Out... from the menu bar.

For example, if you usually change the contents of project files, enable the workstation option Lock Files on Check-out. Then to check out the occasional file that you won’t be editing, select Files · Check Out... from the menu bar to disable that option. Because the file is unlocked, the working copy becomes read-only if you have selected the Mark Unlocked Working Files Read-only workstation option.

Checking in a version:  After you change a working file, check it in. You may be finished with the file or want to be sure that you can return to it at this stage of its completion. Versions records the changes as a new version. As part of the check-in process, you can remove the lock making the file available to others or maintain the lock because you will continue to make changes to the working file. You can also delete the working file.

Check in and Check out dialogs:  The context menus and toolbar buttons provide quick check in and check out. Only the Check In and Check Out items on the Files menu display dialogs from which you can change workstation defaults and provide reasons for checking in files. Usually, you do quick check outs, but check in files using Files · Check In... from the menu bar to document the reason for check in. Your Versions administrator can require you to always provide a reason for check-in—even when using the context menu or toolbar button.

 Related Topics


 Use security

Versions has security features that can allow some users to perform actions that others cannot. Security can be implemented in any of the following ways:

•	No security. Any user can perform any action, such as adding subprojects or deleting files.

•	Project-level security. Any user with administrator status can perform any action. Users without administrator status cannot perform actions that set project/subproject properties or that can result in the loss of data (such as deleting files and defects).

•	A combination of project-level and subproject-level security.

An administrator can create security templates that define sets of actions to be performed. Then users or groups of users can be allowed to perform the actions defined by the template on a subproject-by-subproject basis. Suppose there are two different security templates names Power User and Guest in a project that has three different user groups name Programmers, Testers, and Writers. For the Source Code subproject, the administrator can allow the users in the Programmers group to perform the actions defined by the Power Users template while the users in the Testers and Writers groups can perform only the actions defined by the Guest template. For example, the programmers can add, modify, and delete files from the subproject, while the testers and writers can only read them. However, for the User Manual and On-line Help subprojects, writers would have Power User privileges while programmers and testers would have Guest Privileges.

 Related Topics


Administrator's role in Versions
 Administrator’s role

When you create a Versions project from a project you have been working on, you probably already have a directory structure on your workstation for that project and subdirectories for the logical components of that project. Use these directories as you create the project. For every user who checks out files from the project, Versions can create that same directory structure (or the part of it that they need).

To create the project, you provide its name, its working directory (the directory that is the root of the directory structure), and a name and location for the .stp file for the project database. The .stp file should be accessible to all team members. Usually it is on a network drive in a shared directory where the team members have read, write, create, and delete privileges.

The subdirectories in the directory structure can become subprojects of the project. You can create other subprojects later, even if their working directories are not part of the original directory structure.

The first user of a project automatically becomes its administrator.

When project security is enabled, only administrators can:

•	Create subprojects or branch subprojects.

•	Modify project and subproject properties. For example, this means that only an administrator can enable security.

•	Delete versions

•	Purge non-permanent versions,

•	Change the status of a version from permanent to non-permanent or vice versa.

•	Change the number of non-permanent versions stored for a file.

•	Require users to provide reasons for checking in files.

•	Delete projects.

•	Remove subprojects or files from version control.

•	Manage the user list.

-	Add or delete users.

-	Give users passwords or administrator status.

-	Modify user properties. (Non-administrators can only view the properties.)

•	Break locks set by other users.

•	Designate builds and milestones.

•	Clear the audit log.

 Related Topics


Team member's role in Versions
 Team member’s role

After the project is created, you and the rest of the team add files to the project and its subprojects from the appropriate working directories. Version control can be very important for one individual working on a single file that will have several iterations. However, it is crucial when a group of individuals work on the same set of files. By locking those files and checking them in and out, the team can avoid losing data.

Versions copies the specified version of each file to the appropriate working directory. After a team member modifies a working file and checks it in, Versions stores the file’s contents as a new version in the project database.

Any team member (referred to as a user by Versions) can:

•	Add files to subprojects

•	Lock and unlock files

•	Check files in and out

•	Merge ASCII text files

•	Change a personal password

•	Change the full name, a user property used for e-mail purposes

•	View the audit log

•	Create reports and charts

You can give individual users or groups of user more privileges or fewer privileges on a subproject-by-subproject basis using security templates.

 Related Topics


 Subproject security

 Use security templates to assign users or groups of users certain privileges normally reserved for administrators. You can also use templates to limit the privileges of some users. Only an administrator can assign security templates to subprojects and assign users or groups to those templates. Each user, group, and template must have a unique name.

A default template, named Default, comes with Versions. It is preset to the usual non-administrator privileges, but it is editable.

Also, a default group of users called All Users comes with Versions. Assigning All Users to a template in a subproject, gives every non-administrator the same privileges in that subproject.

If you assign All Users to the Default security template in the root subproject when no other security templates are used in any subprojects, every non-administrator has the same privileges in every subproject. In fact, that is the default when a new project is created with security enabled.

You can give users or deny them the right to:

•	Add files.

•	Read files.
This permits users to check out files (but not check them in).

•	Read and write files.
This permits users to check them out to be changed, and check them back in.

•	Delete files.

If no security template is assigned to a user in a subproject, she or he has the right in that subproject that they have in its parent subproject.

No user or group can be assigned to more than one template per subproject. However, if a user is assigned individually and then in one or more groups in a subproject, she has the maximum (or union) of those privileges in that subproject. For example, if one template allows her to delete files but the others do not, she can delete files.

Deleting users from a project automatically deletes them from any groups and templates to which they were assigned.

 Related Topics


 Use the Versions main window and project window

The Versions main window can display several project windows simultaneously (depending on the amount of memory that is available).

Click each part of the main window to see a brief description in another help window:

When you open a project, a project window appears. The project tree in the left pane lists the project and its subprojects. The project tree has a one-to-many relationship with the lists that appear in the right pane. What the right pane displays depends on:

•	The project, subproject, or file selected from the project tree.

•	The tab you select from below the right pane: Files, History, Team, or Audit. A menu, corresponding to the selected tab, becomes the second menu on the menu bar. For example, if you select the Team tab, the Team list appears in the right pane and the Team menu appears on the menu bar.
The Files and History tabs use the same location. The Files tab appears if you select a project or subproject from the project tree. The History tab appears if you select a file.

•	The filter you select from the Filter drop-down list box above the right pane. For example, you can list the files that are in the project or the files that are in a project’s working directory but not in the project.

•	The scope button you click above the right pane. The leftmost button displays the fewest entries and the rightmost button displays the most.

 Related Topics


Files List: When you select the project or a subproject from the project tree, the Files tab becomes visible below the right pane.

When you select the Files tab:

•	The files list appears in the right pane

•	The Files menu appears on the menu bar

Use the Files menu to add files to the project, check those files in and out, etc.


History List:  When you select a file from the project tree, the History tab becomes visible below the right pane.

When you select the History tab:

•	Τhe file’s version history (the history list) appears in the right pane

•	The History menu appears on the menu bar

Use the History menu to find out details about the number of versions stored for the selected file, compare versions, check them out, etc.


Team List:  When you select the Team tab:

•	Τhe team list appears in the right pane.

•	The Team menu appears on the menu bar.

The team list displays the users who are team members for the current project. Use the Team menu to view information about users and change your password.


Audit Log:  When you select the Audit tab:

•	The audit log appears in the right pane

•	The Audit menu appears on the menu bar

The log lists the actions performed on the project, subproject, or file selected from the project tree. Use the Audit menu to control the log. For example, you may want to clear the log.


Control what is displayed in a Versions project window
 Control what is displayed in a project window

You can control what information about files, versions, users, or audit entries Versions displays in the right pane. You can display a files list, history list, team list, or audit log.

The following actions change what is displayed:

•	Selecting a project, subproject, or file from the project tree.

•	Selecting a tab below the right pane.

•	Clicking one of the scope buttons above the files list or audit log to indicate how much of the branch to display information for.
(These buttons are disabled for the history list and team list.)
  No Descendants
Displays information only for the item selected from the project tree.
  Immediate Descendants
Displays information for the selected item and any items attached to it.
  All Descendants
Displays information for the entire branch. This includes information about the selected item, its subprojects, and their files.

As you move from tab to tab, the selected scope button can return to No Descendants to save time or stay as it is, depending on how you set the workstation display option named Reset Scope Selection on Change. By default, this option is selected and the No Descendants button becomes selected as you change tabs.

•	Selecting a filter from the Filter drop-down list box (for the tabs that provide filters).

•	Clicking a column header to sort the displayed files based on the value in that column. The sort order for most of these columns is ascending alphanumeric. To change the sort order from ascending to descending (or vice versa), click the header a second time. The primary sort column’s header is underlined. Right-click another header for a secondary sort.

When sorting, group bands separate entries with the same value in the sort column. When the values of the sorted column are unique, no group bands appear.

 Related Topics


 Project window: Project tree

The project tree is the hierarchical display of a Versions project and its associated subprojects and files. The project tree is always displayed in the left pane.

Click each part of the project tree to see a brief description in another help window:

A folder icon precedes each project and subproject name. An icon identifying the type of file precedes file names. Clicking the name or the icon displays information about that item in the right pane. What kind of information is displayed depends on what was selected from the tree and what tab is selected from the right pane.

You can expand or collapse branches of the project tree by clicking the following:

 identifies a collapsed branch. Clicking it expands the branch. The open folder icon precedes unselected subprojects when their branches are expanded.

 identifies an expanded branch. Clicking it collapses the branch. The closed folder icon precedes subprojects when their branches are collapsed.

In the project tree, all the files associated with an expanded branch follow all the subprojects associated with that branch. Both sets are in ascending alphanumeric order. Within the tree, an administrator can use drag-and-drop to move a file or subproject. For example, a file at the project level can be moved to one of the project’s subprojects.

After selecting a project, subproject, or a file from the project tree, right-click to display a context menu. You can also apply items from the Project menu to your selection if it is a project or subproject.

Double-click file names in the project tree to run executable files or to open files in the application with which they are associated.

Double-click project and subproject names in the project tree to select them and to expand or collapse branches of the tree.

If the right pane of the project window (not show in the figure), Versions can display the files list, history list, team list, or audit log, depending on the tab selected from the bottom of the pane.


 Project window: Files list

Click each part of the files list to see a brief description in another help window:

What the files list displays depends on:

•	The project or subproject you select from the project tree

•	The depth you specify with the selected scope button

•	The filter you select from the Filter drop-down list box.

The files list contains several columns, each with its own column header.

Two icons precede the name of each file. The first indicates the type of file, such as a document, text, or graphics file. The second indicates whether the file is:

 Not locked by anyone
 Locked by you
 Locked by someone else
 Not in the project

The columns for the files list are:

Name	Name of the file (including any extension).

Ext	Extension of the file.

Locker	User who currently has the file locked.

Exists	Indicates whether the file is in your working directory.

Size	Size of the working file in bytes.

Time stamp	Time stamp of the working file.

Max vers	Maximum number of non-permanent version to be stored for this file.

Description	Description of the file.

Author	Subproject containing the file.

Subproject	File’s parent in the project tree.

Path	Path to the file’s working directory.

Click a column header to sort the displayed files based on the value in that column. The sort order for most of these columns is ascending alphanumeric. To change the sort order from ascending to descending, click the header a second time. The primary sort column’s header is underlined. Right-click another header for a secondary sort.

When sorting, group bands separate entries with the same value in the sort column. When the values of the sorted column are unique, no group bands appear.

After selecting one or more files from the files list, right-click to display a context menu. You can also apply items from the Files menu to your selection.

Double-click file names in the files list to run executable files or to open files in the application with which they are associated.

 Related Topics


 File filters

Filtering allows you to limit the kinds and quantity of files that appear in the files list. Select a filter from the Filter drop-down list box above the files list.

Files in project
Displays only the files that are in the project.

Files not in project
Displays the files in the working directory that are not in, but can be added to, the project.

Files to check in
Displays the files for which the working file is more recent than the latest checked-in version. Versions checks both size and time stamp for changes.

Files to check out
Displays the files for which the latest checked-in version is more recent than the working file or for which there is no working file. Versions records the version number for the version of each file currently in your working directory. If that number is less than the most current version number for the file, the file needs to be checked out. If, for some reason, no version number is stored, Versions uses the size and time stamp to determine what needs to be checked out.

 Related Topics


 Project window: History list

Click each part of the history list to see a brief description in another help window:

The history list contains several columns, each with its own column header, and lists the versions of the file selected from the project tree. The Filter list box and the scope buttons are disabled.

One icon precedes the name of each version. It indicates whether the version is:

 Permanent
 Non-permanent

The columns for the history list are:

Version #	Number Versions gave the version as it was checked in.

Time Stamp	Date and time of the version.

Author	Person who checked in the version.

File Size	Size of the version in bytes.

Reason for Check-In	Reason provided for checking in the version.

Click a column header to sort the displayed versions based on the value in that column. Version # sorts from highest to lowest number. Time Stamp sorts from most recent to earliest time. Otherwise, the sort is in ascending order, numeric or alphanumeric depending on the data. To change the sort order from ascending to descending (or vice versa), click the header a second time. The primary sort column’s header is underlined. Right-click another header to perform a secondary sort.

When sorting, group bands separate entries with the same value in the sort column. When the values of the sorted column are likely to be unique, no group bands appear.

After selecting one or more versions from the history list, right-click to display a context menu. You can also apply items from the History menu to your selection.

Double-click a version to see its properties.

 Related Topics


 Project window: Team list

Click each part of the team list to see a brief description in another help window:

The team list contains each user who is a member of the project team. It has several columns, each with its own column header. (The Filter list box and the scope buttons are disabled.

One icon precedes the name of each user. It indicates the user’s status:

 Administrator
 Non-administrator

Another icon precedes the name of each group:

 Group

The columns for the team list are:

User Name	The name used to log on to the project.

Full Name	The name used for e-mail.

Admin	Indicates (with a Yes or No) whether the user is an administrator.

User Type	Indicates (with User or Group) whether the user entry is an individual or a group users.

Click a column header to sort the displayed users based on the value in that column. Admin sorts Yes to No. Otherwise, the sort is in ascending, alphanumeric order. To change the sort order from ascending to descending (or vice versa), click the header a second time. The primary sort column’s header is underlined. Right-click another header to perform a secondary sort.

When sorting, group bands separate entries with the same value in the sort column. When the values of the sorted column are likely to be unique, no group bands appear.

After selecting one or more users, right-click to display a context menu. You can also apply items from the Team menu to your selection.

Double-click an entry to see its properties.

 Related Topics


 Project window: Audit log

Click each part of the audit log to see a brief description in another help window:

The audit log is a chronological record kept by Versions showing an entry for each action that has occurred to a Versions project, subproject, or file. It lists the entries that are:

•	Attached to the selection from the project tree

•	Match the depth specified by the selected scope button

•	Match the filter selected from the Filter drop-down list box

It contains several columns, each with its own column header. The columns for the audit log are:

Type	The type of action:

 Information, for each normal project activity, such as adding a file to a project or checking in a new version.

 Warning, for non-critical abnormal project activity. For example, if your software "touches" a file to change its time stamp, but its contents remain unchanged, attempting to check it in generates a warning.

 Error, for critical abnormal project activity.

Event	 Name of the action, such as File locked, User added, Project modified, or Subproject deleted.

Time Stamp	Date and time of the action.

User	 Person performing the action.

Description	Description of the action.

Owner	Project, subproject, file, version, or user receiving the action.

Click a column header to sort the displayed entries based on the value in that column. Time Stamp sorts from most recent to earliest in time. Otherwise, the sort is in ascending order, numeric or alphanumeric depending on the data. To change the sort order from ascending to descending (or vice versa), click the header a second time. The primary sort column’s header is underlined. Right-click another header to perform a secondary sort.

When sorting, group bands separate entries with the same value in the sort column. When the values of the sorted column are likely to be unique, no group bands appear.

After selecting one or more entries, right-click to display a context menu. You can also apply items from the Audit menu to your selection.

Double-click an entry to see its properties.

 Related Topics


 Audit log filters

Filtering allows you to limit the kinds and quantity of entries to be displayed in the audit log. Select a filter from the Filter drop-down list box above the audit log. What is displayed is also affected by your selection from the project tree and the scope buttons. The filters are:

<Show All>
Displays all the entries in the audit log.

Date Range = 1 Month
Displays only the entries about actions that were performed within the last month.

Date Range = 1 Week
Displays only the entries about actions that were performed within the last week.

Date Range = Last 24 hours
Displays only the entries about actions that were performed within the last 24 hours.

Only file events
Displays only the entries about actions that were performed on files.

Only project events
Displays only the entries about actions that were performed on projects.

Only subproject events
Displays only the entries about actions that were performed on subprojects.

Only user events
Displays only the entries about actions that were performed on the user list.

Type = Error
Displays only the entries that record errors.

Type = Information
Displays only the entries that record information.

Type = Warning
Displays only the entries that record warnings.

User = Me
Displays only the entries about actions performed by the currently logged on user.

 Related Topics


 Events that Versions audits

Events are actions performed on the owner of those actions. For example, a file can be checked in or removed from version control. The file is the owner of the checking in and removing from version control actions. Such events are recorded in the audit log.

Owner	Event
File	File added
	File checked in
	File deleted  (working file)
	File locked
	File modified
	File moved
	File purged
	File removed  (...from project)
	File unlocked
Project	Build designated
	Label created
	Label deleted
	Milestone designated
	Project created
	Project modified
	Subproject added
	Subproject branched
	Subproject deleted
	Subproject modified
	Subproject moved
	User added
	User deleted
	User modified
	Group added
	Group deleted
	Security template added
	Security template deleted
	Security template modified
	Version modified
	Version deleted
 Related Topics


Filter drop-down list box

Filters that can be applied to the information in the right pane. For example, you can filter the files list for the following:

•	Files in project

•	Files not in project

•	Files to check in

•	Files to check out


Files list

Lists the name of the files that match the selection from the project tree, the depth specified by the selected scope button, and the filter selected from the Filter drop-down list box. You can filter the files for those in or not in the project and for those that need to be checked in or checked out.

This files list displays all the files currently in the project.
You can lock them by clicking Lock [image].
Once they are locked, you can check them out by clicking [image].


Files list

Lists the name of the files that match the selection from the project tree, the depth specified by the selected scope button, and the filter selected from the Filter drop-down list box. You can filter the files for those in or not in the project and for those that need to be checked in or checked out.

This files list displays all the files that are currently in the working directories for the project. It also sorts them by their extensions. None of these files are currently in the project, and therefore, none of them are under version control. The filter Files Not in Project and the bitmap [image] indicate that the files are not in the project.
You select one or more files and click [image] to add non-project files to the project.


Scope buttons

  No Descendants

Displays information only for the item selected from the project tree.

  Immediate Descendants

Displays information for the selected item and any items attached to it.

  All Descendants

Displays information for the entire branch. This includes information about the selected item, its subprojects, and their files.


Project tree

Displays the project, its subprojects, and the files under version control. Each project or subproject has a corresponding working directory.


Files tab

Displays the files in the right pane that are in the project or subproject selected from the project tree in the left pane or in the working directories associated with that project or subproject. For example, if the filter is Files In Project, Files To Check-in, or Files To Check-out, you see the former. If the filter is Files Not In Project, you see the latter.


History tab

Displays the versions in the right pane that are stored in the vault for the file selected from the project tree in the left pane.


Team tab

Displays the team list in the right pane.


Audit tab

Displays the audit entries in the right pane that provide information about the project, subproject, or file selected from the project tree in the left pane.


Team list

Displays the users and groups included in the project. It identifies users as either administrators or team members. Double-clicking a name displays the properties of the selected user or group. Double-clicking yourself allows you to change your password or full name.


Audit log entries

Displays the audit entries that:

•	Correspond to the project, subproject, or file selected from the project tree

•	Correspond to the selected scope button

•	Match the selected filter

In addition, these entries are sorted by event.


Splitter bar

Separates the right and left panes. Drag the splitter bar to adjust how much window space is allocated for each pane.


Status bar

Displays information about menu items, etc. A workstation option allows you to display or hide the status bar.


Splitter bar

Separates the tabs from the horizontal scroll bar for the left pane. Drag to determine where the tabs end and the scroll bar begins.


Menu bar

Displays the names of Versions’s drop-down menus. Click a menu to see the items on it.


Scroll buttons

Scroll the tabs to the right or left.


Scroll bar

Controls what data is displayed in the pane.


Scroll box

Drag to change the contents of the pane controlled by the scroll bar.
This is also called a thumb.


Scroll arrow

Click to move the contents of the pane controlled by the scroll bar in the direction of the arrow. To scroll continuously, hold the left mouse button down.


Column header

The label or name for a column in the right pane. Click a header to sort the contents of the list based on the values in that column. Click a second time to change from ascending order to descending order or vice versa. The primary sort column’s header is underlined. Right-click another column header to perform a secondary sort.

When sorting, bands may appear above each group of entries with the same value in the sort column. When the values of the sort columns are likely to be unique, no group bands appear.
To hide a column, locate the bar that follows the column header (and separates that header from the one that follows it). Drag the bar to the left edge of the column. When you release the mouse button, you no longer see the header.


Disabled options

The history list and the team list have no need for the scope buttons and the filter list box, so they are disabled.


Permanent version

The anchor icon indicates a permanent version.


Non-permanent version

The absence of an anchor icon indicates a non-permanent version.


Purged or deleted versions

Dimmed versions have been purged or deleted from the vault, but the project database file retains historical information about them.


Icon exit

Double-click to exit Versions. Click to see the Control menu that lets you change the window’s size, exit the application, or switch applications.


Open and high priority

This defect submitted against the user manual subproject is both open and high priority. NAllis is responsible for fixing it.


Documented

This defect submitted against the user manual subproject has been fixed. It’s status has been changed to documented by NAllis. StarTeam Workstation automatically returns the responsibility for this defect to the person who submitted it because that person (in this case JSmith) is expected to verify that the defect has been correctly documented.


Verified Documented

This defect submitted against the user manual subproject has been verified. StarTeam Workstation automatically changes the responsibility for the defect to the administrator (JMarinello) who created the project so it can be closed.


Closed Documented

This defect submitted against the user manual subproject has been closed. No one is responsible for it any longer, but the administrator, JMarinello, is still listed.


Selected Subproject or File

This band identifies the subproject or file selected from the project tree.


Other Tabs

The Subproject Properties dialog offers several tabs including Name, User, Commands, Exclude, Description, Defects, and Audit Trail.


Default Tab

When, from Versions, you open a project used StarTeam Workstation, you can view the defects attached to your selection (but not its children) from the project tree.


Title Bar

The bar at the top identifies the property dialog. Because the subproject User Manual is selected from the project tree, the Subproject Properties dialog opens when Properties… is selected from the Project menu or a context menu.


Close button

Click to exit Versions.


Close button

Click to close the project.


Minimize button

Click to minimize Versions.


Maximize button

Click to view Versions in a full-screen window. When full-screen, click this button again to return Versions to its previous size and screen location.


Minimize button

Click to minimize the project window.


Maximize button

Click to fill Versions’s entire child window area with the project window. Click this button again to return the project window to its previous size and location.


Files menu

The second drop-down menu on the menu bar changes to correspond with the tab selected below the right pane of the project window. Right now you see the Files menu, but the History, Team, and Audit menus appear in this same location. Use the items on the Files menu to perform actions on the files selected from the files list.


Project menu

Use the items on the Project menu to perform actions on the project, subproject, or file selected from the project tree. For example, you can open projects or change your working directory for a subproject.


Options menu

Use the Options menu to set options for your workstation. For example, you can set confirmation, display, version control default, and tool options.


Window menu

Use the Window menu to tile or cascade project windows, arrange minimized icons in the main window, select windows, and close report and chart windows.


Help menu

Use the Help menu to use online help.


Title of project window

Stretches across the top of the project window, displaying both the current project’s name and project database filename (.stp).


Title bar

Stretches across the top of the main window. It displays Versions followed by both the current project’s name and project database filename(.stp).


Toolbar

Provides buttons for the most common menu items. Often the button is a shortcut, bypassing the dialog displayed when the item is selected from a drop-down menu. A workstation option allows you to display or hide the toolbar.


Status trays

Indicate when Caps Lock, Num Lock, and/or Scroll Lock are in effect.


Project root

The first folder and name in the project tree identify the project itself.


Collapsed subproject branch

An unselected subproject that is preceded by a closed folder icon is collapsed.
Click Expand [image] to display the contents of such subprojects.


Expanded subproject branch

An unselected subproject that is preceded by an open folder icon is expanded.
Click Collapse [image] to hide the contents of such subprojects.


Contents of subproject

The selected subproject contains these Word documents. Notice that each file is preceded by an icon indicating the type of file it is.


 Technical support

If you have a question about Versions, you can:

1.	Consult the on-line help and written documentation.

2.	See the readme.wri file that came with Versions.

3.	Post a message to our CompuServe forum. Log on to CompuServe and type GO STARBASE, then visit the Versions message and library sections.

4.	Send an e-mail message to support@starbasecorp.com.

5.	Access our web site at http://www.starbasecorp.com and check for new support questions and answers.

If you can’t find the answer from any of these sources, or if you require information about product registration or replacement disks, call StarBase Technical Support Services at (714) 442-4460 between 9 A.M. and 5 P.M. Pacific time, Monday through Friday.

When you call StarBase Corporation Technical Support Services, please have the following information:

•	The version number of the software you are using.
(Select Help | About...)

•	The exact error message you received, if any.

•	A precise explanation of what you were doing when the error occurred.

•	The version of Windows you are using.
(Select Start · Settings · Control Panel. Then select the System icon. The version appears on the General dialog.)

•	The type of hardware you are using.

•	The network operating system you are using, if any.

StarBase support services are subject to StarBase prices, terms, and conditions in place at the time the service is used.

For information about product upgrades and pricing, call StarBase Corporation at 1-888-STAR700 or (714) 442-4500 between 9 A.M. and 5 P.M. Pacific time, Monday through Friday.


 Quick start: Create a project

Creating a project allows you to put files under version control and audit users’ actions. Usually, you already have related files grouped into directories. Make one of these directories the root working directory for your project. Subdirectories of that root can become the working directories for subprojects automatically. Directories from other locations can be added as subprojects later using Project · Subproject · New... from the menu bar.

When you create a project using Versions, you must provide a project name, designate a working directory, and provide the name and location of a project database file (.stp).

To create a project:

1.	Click New Project [image] on the toolbar.
Or,
Select Project · New... from the menu bar.
The New Project dialog opens.

2.	Type a name for the project in the Project Name text box. The project name should reflect the nature of the project. Use a maximum of 228 characters, but do not use forward slashes (/), backward slashes (\), or exclamation points (!).

3.	In the Working Directory text box, type the path to the directory to be used on individual workstations as the working directory for this project.
Or,
Click Browse... to locate that directory.
The working directory can be an existing directory. Or Versions can create the directory for you.

4.	Select the Force Default Working Directory check box to require each user to store the working copies of files attached to the root of the project in the working directory on his or her workstation with the path that you specified as the default.
Clear this box to allow users to specify their own working directories for these files.

5.	Select the Configure Subdirectories as Subprojects check box so that all subdirectories of the project’s working directory become the working directories of subprojects. The names of the subdirectories become the names of the subprojects.
Clear this box to create no subprojects at this time.

6.	The Force Default Working Directories for Subprojects check box is enabled only when you select Configure Subdirectories as Subprojects. Select this box to require every user to store each subproject's working files on his or her workstation in the working directory specified by the default working directory and the path from it to the subdirectory.
Clear this box to allow users to specify their own working directories for these files.

7.	Because the Security check box is selected, users must provide passwords and sensitive actions (such as deletions) are restricted to administrators.
You automatically become an administrator for any project you create.

8.	Because the Audit Log check box is selected, all the actions performed by users on the project will be logged.

9.	Type the name of the project database file in the File Name text box. By default, the file has the extension .stp.

10.	Type the path to the directory where you will store the project database file. Versions also stores the project vault there.
Or,
Click Browse... to simplify this process.
Usually the project database file is on a network drive in a location that is accessible to all team members.

To set additional, advanced properties:

1.	Click Advanced....
The Advanced Project Settings dialog opens.

2.	If you want to use mail from within Versions or use compression for file versions, select Use Mail or Use Compression.

3.	Select the Description tab, then type a description of the project using a maximum of 255 characters.

4.	Click OK until you see the New User dialog.
Your logon name appears in the User Name text box. Use it or type another name to use when you log on to Versions. Select this name carefully, because it cannot be changed.

5.	In the Full Name text box, type your e-mail name if you are using e-mail within Versions.
When using Microsoft Exchange, the full name and the Exchange profile name should be the same. Otherwise Microsoft Exchange returns an error message each time you log on to the Versions project. If this occurs, create a new Exchange profile with the same name as your Versions user name.

6.	Because you enabled security, you must also type and confirm a password.
Passwords are case-sensitive and must contain at least six characters.

7.	Click OK again.
The project window opens. It has two panes: the project tree on the left and the files list on the right.
The filter is the Files Not in Project so that you can select files from the working directory to be added to the project.


 Quick start: Add files to a project

When you create a project, it is empty. The project tree displays an empty folder for each of its subprojects. The files list displays the files in the project's working directory. You can add those files to the project, putting them under version control. Please add at least one text file (for later use) to the project. Later you will check in additional versions for storage or check out versions to work on.

To add files to a project:

1.	Normally, the default filter is the Files In Project filter. When you have just created a project, however, the filter is Files Not in Project filter so that all the files in the project’s working directory appear in the files list.

To display the files in the subprojects’ working directories as well, click the rightmost of the three scope buttons above the files list.

2.	Select at least one text file to be added to the project or select Files · Select All from the menu bar.
(You will check in additional versions of the text file later.)

3.	Select Files · Add Files... from the menu bar.
The Add Files dialog opens.

4.	Type a generic description for all the files in the File Description text box.
Or,
Select the Prompt for Description for Each File check box.

5.	If retrieving these files as a group or if retrieving this specific version of the one file being checked in will be important, type a label in the Version Label text box. For example, you may label a file as "technical review."

6.	To store these files permanently, select the Permanent check box.
(Otherwise Versions deletes the oldest version of a file whenever the number of stored versions for that file exceeds its maximum.)

7.	Click OK.
The names of the selected files disappear from the files list and appear on the project tree.
The Enter Description dialog opens if you selected Prompt for Description for Each File check box. Type descriptions as necessary.
Remember that this description can help you identify this version of a particular file later.

8.	Change the filter to Files In Project to display the names of the project files in the files list.


Quick start: Check in a version of a file
 Quick start: Check in a version

Now that you have added files to your project, you are ready to check in and check out. Because you did not instruct Versions to delete the copies of your files in the working directories, you can use one of those files for practice. Please use a text file that you added to the project.

To modify the file:

1.	Select the name of the file from the files list.

2.	Select Files · Edit from the menu bar.
The file appears in the text editor specified as a workstation default. (Notepad is the default.)

3.	Modify the file, save it, and exit the text editor.

To check the new version in:

1.	Select the name of the file from the files list again.

2.	Select Files · Check In... from the menu bar.
The Check In dialog opens.

3.	Describe your change to this file in the Reason for Check-In text box. Use a maximum of 20K characters.


 Quick start: Review version history

Reviewing the version history can help you choose between versions. Please use a previously checked-in text file with the following procedure.

You can review the version history for a file in either of the following ways:

•	Display the files list in the project window’s right pane and the history list in the File Properties dialog

•	Display the history list in the project window’s right pane

Usually the first way is more convenient, but try both.

To display the history list in the File Properties dialog:

1.	Right-click the name of the file in the files list.
The context menu opens.

2.	Select Properties....
Or,
Press Alt+Enter.
The File Properties dialog opens.

3.	Select the History tab.
The history list contains the versions stored for the file starting with the most recent version.
The history list also displays information about the version, such as the number Versions assigned to it and the reason why it was checked in.

To display the version history in the right pane:

•	Select the name of the file in the project tree.
The history list replaces the files list.


 Quick start: Compare versions

While you are reviewing the version history for a text file, it is a good time to compare two of its versions. When you compare files or versions, Versions sends a command-line file to Visual Diff.

To compare two versions:

1.	Select two versions of a text file from the history list.

2.	Click Compare [image] on the toolbar.
Or,
Select History · Compare from the menu bar.
Visual Diff, Versions’s differencing program, displays the two versions, indicating the differences with different colors.

3.	Select Files · Exit from the Visual Diff menu bar to return to Versions.

Other ways to compare text files or versions of a text file include:

•	Select one version in the history list to compare it to the working file using History · Compare from the menu bar.

•	Select two files in the files list to compare them using Files · Compare from the menu bar.

•	Select one file in the files list to compare it to the working file using Files · Compare from the menu bar.

For any of the above, you can also click Compare [image] on the toolbar.


Quick start: Check out a version
 Quick start: Check out an earlier version

If you have a file locked and are the only person working on it, you can check versions in continually without ever checking the file out. However, you must check out a version of a file if you:

•	Have deleted the working file

•	Want to return to a previous version of the file

•	Need to get the most recent version of a file worked on by someone else

Try checking out the earlier of the two versions you just compared.

To check out an earlier version of a file:

1.	Select the name of the file from the project tree.

2.	Select the version from the history list.

3.	Click Check Out [image] on the toolbar.
Or,
Select History · Check Out from the menu bar.

To confirm that you have the earlier version as a working file:

1.	Select the name of the project or subproject that contains the file from the project tree.
The files list opens.

2.	Select Files · Edit from the menu bar to look at the working file.
The file appears in NotePad.


 Quick start: View the team list

The team list displays the names of the team members: their names in the project, their e-mail names, and whether they have administrator status. Team members must select their names here before changing their passwords.

It also displays the names of groups. A group is a list of user to be assigned to security templates. Only administrators can create groups.

To view the team list:

•	Select the Team tab below the right pane.
The team list appears in the right pane.


 Quick start: View the audit log

The audit log lists the actions performed on the project, subproject, or file selected from the project tree.

To view the audit log:

1.	From the project tree, select the project, subproject, or file about which you are concerned.

2.	Select the Audit tab below the right pane.
The audit log appears in the right pane.

3.	Select a filter from the Filter drop-down list box to display only the entries of interest.

4.	Click a column header to sort the displayed entries based on the value in that column. The sort order for most columns is ascending alphanumeric. To change the sort order from ascending to descending (or vice versa), click the column header a second time. The primary sort column’s header is underlined. Some sorts add group-bands to the right pane.

5.	Right-click another column header to perform a secondary sort.

6.	Double-click an entry to see its properties.


Quick start: View a chart
 Quick start: Create a chart

Versions offers a variety of charts. Charts... appears on the Files, History, Team, and Audit menus.

To create a chart of file sizes:

1.	Select the project name from the project tree.

2.	Select the Files tab below the right pane.
The files list appears in the right pane.

3.	Select Files · Select All from the menu bar.

4.	Select Files · Charts... from the menu bar.
The Chart Selection dialog opens.

5.	Select File Sizes from the Charts list box.

6.	Click Chart to display a chart of file sizes.


Quick start: View a report
 Quick start: Create a report

Versions offers a variety of reports. Reports... appears on the Files, History, Team, and Audit menus.

To create a report of file details:

1.	Select the project name from the project tree.

2.	Select the Files tab below the right pane.
The files list appears in the right pane.

3.	Select Files · Select All from the menu bar.

4.	Select Files · Reports... from the menu bar.
The Reports dialog opens.

5.	Select File Details from the Reports list box.

6.	Click Preview to generate and preview a report of file details.
The Versions report window displays the report. The name of the report appears in the window’s title bar.

 Related Topics


 Use Versions and StarTeam together

Since Versions and StarTeam both use the same format and file extensions (.stp and .vlt), you can share and view files between applications. In fact, Versions and StarTeam can access the same projects simultaneously. However, StarTeam Workstation offers additional functionality. It allows you to add or edit defects that you can only view in Versions. StarTeam Workstation also allows you to add threaded conversations to projects, subprojects, and files.

 Related Topics


 Open a project for use with both Versions and StarTeam Workstation

Opening a project is similar in both Versions and StarTeam Workstation. However, you have more options with StarTeam Workstation.

When you open a project with Versions, you must know the name of its project database file (.stp) and have read/write access to the location where it is stored. This gives you file server access (also called local access) to the project. With file server access, data is processed on your workstation.

When you open a project with StarTeam Workstation, you can open it for file server access or for client/server access. With client/server access (also called remote access), data is processed on the server and only the results are sent to your workstation. Client/server access is possible only when StarTeam Workstation is used with its companion product, StarTeam Server.

The following procedure assumes that you are using file server access for both Versions and StarTeam Workstation.

To open a project:

1.	Open either Versions or StarTeam Workstation.

2.	Select Project · Open… from the menu bar.
The Open Project dialog opens.

3.	Use the Look In drop-down list box (and the list box beneath it) to select the drive and directory where the project is located.

4.	Double-click the project database file (.stp) to be opened.
The Log On dialog opens.

1. 	Type your password if one is required.
A project window displays the project and its subprojects.

 Related Topics


 View defects in Versions

When you use Versions along with StarTeam Workstation, you can view the defects submitted via StarTeam Workstation from Versions using the Defects dialog for subproject and file properties.

Click each part of the defects list to see a brief description in another help window:

The defects list contains the defects that are:

•	Attached to the selection from the project tree—and not to any of its children

The defects list contains several columns, each with its own column header.

Two icons may precede each defect. One indicates its status; the other appears only if the defect is a priority.

The columns for the defects list are:

Defect #	Number StarTeam Workstation assigned to the defect when it was first submitted.

Status	Indication of the defect’s progress from open to resolved to verified to closed. This is referred to as a defect’s life cycle.

Priority	Indication that the defect is a [image] Priority or Not a Priority.

Severity	Seriousness of defect:	 High
 Medium
 Low

Responsibility	Person who is currently responsible for the defect.

Synopsis	Short explanation of the defect.

Date Entered	Date the defect was submitted.

Build Tested	Build in which the defect occurs.

Build Addressed	Build in which the defect is resolved.

Author	Person who submitted the defect.

Type	Type of defect:	 Defect
 Suggestion

Owner	Subproject or file to which the defect is attached.

Click a column header to sort the displayed defects based on the value in that column. Severity sorts from high to medium to low. The sort for status reflects the defect’s life cycle, from open to closed. Time Stamp sorts from most recent to earliest time. Otherwise, the sort is in ascending order, numeric or alphanumeric depending on the data. To change the sort order from ascending to descending (or vice versa), click the header a second time. The primary sort column’s header is underlined. Right-click another header to perform a secondary sort.

When sorting, group bands separate entries with the same value in the sort column. When the values of the sorted column are likely to be unique, no group bands appear.

After selecting one or more defects, right-click to display a context menu. You can also apply items from the Defects menu to your selection.

The defects you have not read are in bold type; defects in regular type are those that you have updated.

To see a defect’s properties, double-click it.

 Related Topics


 Upgrade to StarTeam

Versions can be easily upgraded to the StarTeam product family which offers additional functionality such as:

•	Client/server architecture

•	Defect tracking

•	Threaded conversations

•	Internet, WAN, and dial-up connectivity.

Versions lets you get started with an effective version control solution. StarTeam offers a more advanced and robust software configuration management solution for your growing projects. All of your Versions projects can be accessed in StarTeam Workstation.

StarTeam includes StarTeam Workstation, StarTeam Server, and StarTeam Web Connect.

StarTeam Workstation is a tightly integrated suite of SCM tools including version control, visual differencing, defect tracking, threaded conversations, build management, audit logs, status reports, and an advanced project repository. StarTeam Workstation focuses on the larger team issues that affect delivery of applications on time and on budget.

StarTeam Server provides support for distributed StarTeam Workstation development teams and mobile team members by providing access to projects through Internet, intranet, WAN, or dial-up connectivity. This removes any limitations on where development team members or consultants are located. In addition, StarTeam Server uses client/server technology to increase performance and reduce network traffic. It provides a scaleable, secure solution that serves the needs of even the largest development team.

StarTeam Web Connect provides access to application and web site projects via a web browser. This revolutionary way of working with and managing projects allows a wide range of users to participate in an easy, secure, and cost effective development process. StarTeam Web Connect allows different views of the same project and dynamically gives each user the appropriate project view based on the rights assigned to that user by the administrator.

As part of an application development project, StarTeam Web Connect provides a way for beta users, testers, consultants, and others to interact, provide feedback, and review information.

As part of a web site project, it allows the webmaster to create a framework that meets the needs of everyone involved with content, graphics, testing, and responding to user input. In addition, StarTeam Web Connect is ideal for controlling web site configuration and can operate standalone or in conjunction with a commercial HTTP server.

 Related Topics


View defects in Versions
 Who needs StarTeam?

StarTeam offers an Integrated Team Environment (ITE) by using one interface for all resources. StarTeam runs on Windows 95 and Windows NT, and supports all popular file-based programming environments including C++, Visual Basic, Delphi, JAVA, and Perl. Developers work more productively as a team because they have quick access to all project information and each other across the LAN. With the optional StarTeam Server and StarTeam Web Connect, developers and others can also access projects over Internet, intranet, WAN, remote dial-up, and web browser. StarTeam is recommended for:

•	Projects requiring integrated version control, defect tracking, and threaded conversation

•	Web Site management

•	Managers and developers needing to know project status

•	Local and distributed development teams

•	Interdepartmental teams including beta users, testers, writers, and consultants

•	Projects requiring strong security

 Related Topics


View defects in Versions
 Feature Comparison

Feature	Versions	StarTeam
SCM Functionality	Version control Visual differencing Build management Audit logs Project repository File, version history, team, and audit log charts & reports	Version control Visual differencing Build management Audit logs Project repository File, version history, team, audit log, defect, and threaded conversation charts & reports Defect Tracking Threaded Conversations
Scalability	FAT Client/LAN	FAT Client/LAN Client/Server
Communication	N/A	Internet Dialup WAN
Web Browser Access	N/A	Yes
Web Site Management	N/A	Yes
Security	Limited	Advanced
To order StarTeam Workstation, StarTeam Server, and/or StarTeam Web Connect, please contact StarBase Corporation at 1-888-STAR-700 between 9 A.M. and 5 P.M. Pacific time, Monday through Friday.

 Related Topics


$NoKeywords$


Create a Versions project
 Create a project

Creating a project allows you to put files under version control and audit users’ actions.

Before you create the project, you may need to consider the following:

•	You can designate builds and milestones only at the project level. If you need build labels and milestone labels at the subproject level, you may need to break your current project into a series of projects.

•	Will you need project security, so that actions such as deletions can only be performed by an administrator? If so, set security. If not, turn security off.

When you create a project, you provide a project name, designate a working directory, and provide the name of the project database file (.stp). As the creator of the project, you automatically become an administrator of it.

To create a project:

1.	Click New Project [image] on the toolbar.
Or,
Select Project · New... from the menu bar.
The New Project dialog opens.

2.	Type a name for the project in the Project Name text box. The project name should reflect the nature of the project. Use a maximum of 228 characters, but do not use forward slashes (/), backward slashes (\), or exclamation points (!).

3.	Type the path to the directory to be used on individual workstations as the default working directory for this project in the Working Directory text box.
Or,
Click Browse... to locate that directory.
Do not use Universal Naming Convention (UNC) pathnames or all users will be forced to use the same working directory (instead of local directories with identical pathnames). For example, the working directory c:\bigproj\working specifies a working directory on each user’s local c: drive, while the working directory \\domain\mydisk\working specifies that physical location for a single working directory shared by all team members.

4.	Select the Force Default Working Directory check box to require all users to use the root subproject’s default working directory on their workstations.
Clear this box to allow users to specify their own working directories for files in the root subproject.

5.	Select the Configure Subdirectories as Subprojects check box so that all subdirectories of the project’s working directory become the default working directories of subprojects. The names of the subdirectories become the names of the subprojects.
Clear this box to create no subprojects at this time.

6.	The Force Default Working Directories for Subprojects check box is enabled only when you select Configure Subdirectories as Subprojects. Select this box to require all users to use each subproject's default working directory on their workstations for working files.
Clear this box to allow users to specify their own working directories for these files.

7.	The Security check box is selected by default, requiring passwords to log on to the project and administrator privileges to perform sensitive actions. Clear it to allow anyone complete access to the project.

8.	The Audit Log check box is selected by default so that all actions performed on the project will be logged. Clear it to avoid logging events.

9.	Type the name of the project database file in the File Name text box. By default, the file has the extension .stp.

10.	Type the path to the directory where you will store the project database file. Versions also stores the project vault there.
Or,
Click Browse... to simplify this process.
Usually the project database file is on a network drive in a location that is accessible to all team members.

11.	Click Advanced... to set additional options.
The Advanced Projects Settings dialog opens.
Use it to specify:

•	Defaults for the project and for project files

•	Users

•	Build and test commands

•	Files never to be added (at the project level)

•	A project description

12.	Click OK.
The New User dialog opens.

13.	Type the name you will use to log on to this project in the User Name text box.
Select this name carefully, because it cannot be changed.
(Usually people use their network logon name.)

14.	In the Full Name text box, type your e-mail name to use MAPI-compliant e-mail efficiently from Versions.
When using Microsoft Exchange, the full name and the Exchange profile name should be the same. Otherwise Microsoft Exchange returns an error message each time you log on to the Versions project. If this occurs, create a new Exchange profile with the same name as your Versions user name.

15.	If you enabled project security, you must also type and confirm a password.
Passwords are case-sensitive and must contain at least six characters.

16.	Click OK again.

The project window displays the new, but empty, project. The project window has two panes: the project tree is on the left and the files list is on the right.

Versions creates a project database that consists of an .stp file for general project information and a .vlt directory which becomes the vault for file versions. These extensions are preceded by the name you give the .stp file as you create the project. The .stp file is the one you select when you open the project database.

Because you have just created a project, the Files Not In Project filter appears in the Filter drop-down list box. This allows you to see (and add to the project) files from the project’s working directory.

 Related Topics


Defaults (for new project)
 Defaults

To specify defaults (optional):

1.	The number of non-permanent versions stored for any file in the project depends on the file’s storage type. By default, Versions stores a maximum of 32767 versions of files using either delta storage and omega storage.

To change the number of non-permanent versions stored:

a.	Select the Maximum or Limited option button for one of the storage types.

b.	If you selected Limited, type a maximum number of versions in the Limited text box.

c.	Repeat steps a and b for the other type of storage, if applicable.

You can override this setting for specific files as you add them to the project or, later, by modifying their file properties.

2.	The time stamp on working files can be reset with the time they are checked out. Select the Time Stamp Working File with Check-out Time check box to use the check-out time. Clear the box to copy the time stamp of the version along with the version.
(The difference is whether the working file appears to be more recent than the copied version immediately or only after it has been updated.)

3.	Select the Use Mail check box if the users have a MAPI-compliant e-mail. This allow users who have logged on to mail to take advantage of the Send To... commands on the drop-down menus and be notified by e-mail when a lock is broken.

4.	Select the Keyword Expansion check box to use keywords in your files.

5.	Select the Use Compression check box to compress all the files stored in the project’s vault.

6.	Select the Force Check-in Reason check box to require users to provide a reason for check in—even when they click the Check In button on the toolbar or select Check In from a context menu.


Build and test commands (for new project)
 Users

To specify users for this subproject (optional):

1.	Select a template from the template drop-down list box.

2.	Click Add…
The Add Users dialog opens.

3.	Select the users and or groups that will have the privileges defined by the selected template.

4.	Repeat steps 1 through 3 for any other templates.


Build and test commands (for new project)
 Build and test commands

To specify build commands and test commands (optional):

1.	Select the Commands tab.

2.	Type the command that builds the project.
Or,
Click Browse... to locate that command.

3.	Type the command that tests the project.
Or,
Click Browse... to locate that command.


Files never to be added (for new subproject
 Files never to be added

To keep users from adding unwanted files to a subproject, you can create an exclude list. The exclude list affects the files only in the working directory for the selected subproject (and not in the directories for the selected subproject's children).

To create an exclude list:

1.	Select the Exclude tab.

2.	Select the Use Exclude List check box.

3.	Type the names of files and/or file specifications to be excluded. Use wildcards (for example, *.tmp) and separate the filenames with semicolons or commas.


Description (for new subproject)
 Description

To provide a project description (optional but strongly recommended):

1.	Select the Description tab.

2.	Type a description of the project using a maximum of 255 characters.


Log on to a Versions project
 Log on to a project

To open or log on to project:

1.	Select Project · Open... from the menu bar.
The Open dialog opens.

2.	Locate and select the project database file (.stp) for your project, then click Open.
The Log On dialog opens for existing users and the New User dialog opens for new users.

3.	Type your name in the User Name text box, unless it is already displayed there.
If security is disabled, User Name is the only text box on this dialog. In that case, logging on to a project adds you as a project member with the log on name you have specified. Select your name carefully, because it cannot be changed.
When using Microsoft Exchange, the full name and the Exchange profile name should be the same. Otherwise Microsoft Exchange returns an error message each time you log on to the Versions project. If this occurs, create a new Exchange profile with the same name as your Versions user name.

4.	If security is enabled, type your password in the Password text box.
If security is disabled, the Password text box does not appear.
If you have opened this project without a password before security was disabled, you password is blank.

5.	Click OK.
The Project window displays the tree for your project. The name of your .stp file appears on the title bar.
By default, the item selected from the tree is your project.

TIP: Select the name of a recently opened project from the bottom of the Project menu. There are separate lists for projects accessed locally and projects accessed remotely.


Create a Versions subproject
 Create a subproject

After a project has been created, you can add any directory to the project as a subproject. Adding files from that directory to the subproject puts them under version control and allows you to audit users’ actions.

 When project security is enabled, only an administrator can create a subproject.

To create a subproject:

1.	From the project tree, select the subproject to which the new subproject will be attached.

2.	Click New Subproject [image] on the toolbar.
Or,
Select Project · Subproject · New... from the menu bar or New Subproject... from the context menu.
The New Subproject dialog opens.

3.	Type a name for the subproject in the Subproject Name text box. Use a maximum of 228 characters, but do not use forward slashes (/), backward slashes (\), or exclamation points (!).

4.	Type the path to a working directory for the new project.
Or,
Click Browse... to locate that directory.
The working directory can be the root of an existing directory structure. Or Versions can create the directory for you.
Do not use Universal Naming Convention (UNC) pathnames or all users will be forced to use the same working directory (instead of local directories with identical pathnames). For example, the working directory c:\bigproj\working specifies a working directory on each user’s local c: drive, while the working directory \\domain\mydisk\working specifies that physical location for a single working directory shared by all team members.
If you specify a directory that does not exist, Versions can create the directory for you.

5.	Select the Force Default Working Directory check box to require each user to store the working copies of files attached to this subproject in the working directory on his or her workstation with the path that you specified as the default.
Clear this box to allow users to specify their own working directories for these files.

6.	Select the Configure Subdirectories as Subprojects check box so that all subdirectories of this subproject’s working directory become the working directories of subprojects. The names of the subdirectories become the names of the subprojects.
Clear this box to create no additional subprojects at this time.

7.	The Force Default Working Directories for Subprojects check box is enabled only when you select Configure Subdirectories as Subprojects. Select this box to require every user to store each subproject's working files on his or her workstation in the working directory specified by the default working directory and the path from it to the subdirectory.
Clear this box to allow users to specify their own working directories for these files.

8.	Click Advanced... to set additional options.
The Advanced Subprojects Settings dialog opens.
Use it to specify:

•	Users

•	Build and test commands

•	Files never to be added (at the subproject level)

•	A subproject description

To finish creating the subproject:

1.	After completing the steps explained above, click OK.
The new, but empty, subproject appears in the project tree. Versions adds the new subproject to the project database.

2.	Select the File Not in Project filter from the Filter drop-down list box to see the files that can be added to the subproject and, therefore, to the project vault.

 Related Topics


Build and test commands (for new subproject)
 Build and test commands

To specify build commands and test commands (optional):

1.	Type the command that builds the subproject.
Or,
Click Browse... to locate that command.

2.	Type the command that tests the subproject.
Or,
Click Browse... to locate that command.


 Add files to a subproject

Adding files to a subproject puts those files under version control. Once the files are added, you can also audit when they are checked in and out.

You add files from any working directory on your workstation to the subproject that corresponds to that directory. The contents of the working files become the first versions of those files stored in the project vault. In fact the reason for check-in for an added file is automatically "initial version."

If the working directory for the subproject is not already on your computer:

1.	Select Project · Subproject · Create Directory Structure... from the menu bar.
Versions automatically creates the path to the working directory for the subproject you selected. It also creates the working directories for the subprojects of your selection.

2.	Move the files to be added to the project to the working directory or create them there.

TIP: If the administrator allows you to select your own working directories, you can specify more convenient locations on your workstation’s hard drive for the project or a subproject’s files. For example, you might want to use a shorter path or a different drive letter. To specify a working directory, select a subproject from the project tree. Then select Properties... from the Project menu or a context menu or press Alt+Enter.

To select the files to be added:

1.	Select a subproject from the project tree.

2.	Select the Files tab below the right pane.
The files list appears in the right pane.

3.	Select Files Not In Project from the Filter drop-down list box above the files list.
The files list contains the names of any files in your working directory that are not already under version control.

4.	Select the files to be added from the files list.

TIP: Use the Immediate Descendants [image] or All Descendants [image] buttons to add files across multiple subprojects. To select all the files simultaneously, use Select All from the Files or context menu.

To add files quickly using the current project and workstation defaults:

1.	Select the files to be added.

2.	Click Add Files [image] on the toolbar.
Or,
Select Add Files from the files list context menu.

To add the files and set options for them:

1.	Select the files to be added.

2.	Select Files · Add Files... from the menu bar.
The Add Files dialog opens.

3.	Select the Lock Files check box to lock the files (with you as the locker) or clear the box to leave the files unlocked at this time. When you lock a file, only you can work on it unless another team member breaks your lock. When project security is enabled, only an administrator can break your lock.

4.	Select the Permanent check box to make the first versions of these files permanent or clear the box to make the versions non-permanent.

5.	Select the Delete Working Files check box to delete the files from your workstation, storing them only in the project vault or clear the box to leave the working files in the working directory.

6.	By default, text files use delta storage, and binary files use omega storage. If the selected files are text files that are large and change frequently, select the Force Omega check box to apply omega storage to these files.

7.	The number of non-permanent versions stored for any file in the project depends on the file’s storage type. By default, Versions stores a maximum of 32767 versions of files using either delta or omega storage.

To change the number of non-permanent versions stored:

a.	Select the Maximum or Limited option button for one of the storage types.

b.	If you selected Limited, type a maximum number of versions in the Limited text box.

c.	Repeat steps a and b for the other type of storage, if applicable.

8.	Type a generic description for all the files in the File Description text box using a maximum of 255 characters.
Or,
Select the Prompt for Description for Each File check box.

9.	If retrieving these files later as a group or if retrieving this specific version of the one file being checked in will be important, type a label in the Version Label text box. For example, you may label a file as "technical review."

10.	Click OK.
The names of the selected files disappear from the files list and appear on the project tree.
The Enter Description dialog opens if you selected the Prompt for Description for Each File check box. Type descriptions as necessary.

11.	Change the filter above the files list to Files In Project so you can see the names of your files in the files list again.

 Related Topics


 Exclude files from a subproject

From the files list, use the Files Not In Project filter to view files that exist in the project's working directories but have not been added to the project. Use an exclude list to limit the files that this filter displays to only those files that you might want to add to the project. The filenames you exclude at the project level affect only the files in the project's working directory. You create additional exclude lists for subproject working directories as necessary. In other words, exclude lists apply to one working directory only and not to the working directories of the selected subproject's children.

To avoid adding unwanted files to a subproject:

1.	Select a subproject from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties or Subproject Properties dialog opens.

3.	Select the Exclude tab.

4.	Select the Use Exclude List check box.

5.	Type the names of files to be excluded. Use wildcards (for example, *.tmp) and separate the filenames with semicolons or commas.


 Change your project password

When project security is enabled, you can change your personal password. Otherwise, there is no need for passwords; Versions does not ask for them.

To change your password:

1.	Select the Team tab below the right pane.
The team list appears in the right pane.

2.	Double-click your name in the team list.
Or,
Select your name. Then select Properties... from the Team menu or the context menu.
The User Properties dialog opens.

3.	Type the new password in the Password text box.
Passwords are case-sensitive and must contain at least six characters.

4.	Retype the new password in the Confirm text box to prove it was typed correctly at step 3.

 Related Topics


Build a Versions subproject
 Build a subproject

 When project security is enabled, only an administrator can build a subproject.

To build a subproject:

1.	From the project tree, select the subproject to be built.

2.	Select Project · Build from the menu bar.


Test a Versions subproject
 Test a subproject

 When project security is enabled, only an administrator can apply a test command to a subproject.

Before you can test a subproject, a test command must be specified as one of its properties.

To test a subproject:

1.	From the project tree, select the subproject to be built.

2.	Select Project · Test from the menu bar.

 Related Topics


Change a Versions subproject's build command
 Change the build command

A build command is a single command that you may specify so that Versions may, with a single operation, compile, assemble and link all project files in proper sequence to produce the subproject’s product.

To change the build command for a subproject:

1.	Select the subproject from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties or Subproject Properties dialog opens.

3.	Select the Commands tab.

4.	Type a new command in the Build Command text box.
Or,
Click Browse... to locate a new command.

 Related Topics


Change a Versions subproject's test command
 Change the test command

To change the test command for a subproject:

1.	Select the subproject from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties or Subproject Properties dialog opens.

3.	Select the Commands tab.

4.	Type a new command in the Test Command text box.
Or,
Click Browse... to locate a new command.

 Related Topics


Designate a project build
 Designate a build

A build represents a quantifiable step of progress. For example, a software product may deliver a new build every few days to the team members who test the product. This feature is not available at the subproject level.

When you designate a build, you create a single set of non-permanent versions for the files in a project. The specified version of each file receives the build label.

For example, suppose the same version of a file ends up in two separate builds and a milestone. That version stores both build labels and the milestone label. A version can have any number of labels.

 When project security is enabled, only an administrator can designate a build.

To designate a build:

1.	Select the root subproject from the project tree.

2.	Select Project · Designate Build... from the menu bar.
The Designate Build dialog opens.

3.	Type a name or label for the build in the Name text box.

4.	Indicate what versions to include by selecting one of the following option buttons.

•	Latest Version for the most recent versions.

•	Current As Of for the versions checked-in at or before the date and time you specify.

a.	To specify the date, type the date in the text box.
Or,
Click the button between the date and the time to use the calendar. Specify the date using the next and previous month buttons and the arrow keys.

b.	To specify the time, type the time in the text box, then select the AM or PM option button.

 Related Topics


Designate a project milestone
 Designate a milestone

A milestone represents a significant step in progress for a project. For example, the label may indicate that the files represent the alpha, beta, or final release of a product.

In Versions, a milestone designates a single set of permanent versions for the files in a project. The specified version of each file receives the milestone label.  For example, suppose the same version of a file ends up in two separate builds and a milestone. That version stores both build labels and the milestone label. A version can have any number of labels.

 When project security is enabled, only an administrator can designate a milestone. Even though a milestone creates permanent versions, you do not have to lock the files.

To designate a milestone:

1.	Select the root subproject from the project tree.

2.	Select Project · Designate Milestone... from the menu bar.
The Designate Milestone dialog opens.

3.	Type a name or label for the milestone in the Name text box.

4.	Indicate what versions to include by selecting one of the following option buttons.

•	Latest Version, for the most recent versions.

•	Current As Of, for the versions checked-in at or before the date and time you specify.

a.	To specify the date, type the date in the text box.
Or,
Click the button between the date and the time to use the calendar. Specify the date using the next and previous month buttons and the arrow keys.

b.	To specify the time, type the time in the text box, then select the AM or PM option button.

•	Build, for the versions in the build specified using the Build drop-down list box.

 Related Topics


 Check out a build or milestone

Both builds and milestones are sets of file versions with the same label. The milestone represents a significant step in the life cycle of the product and is permanent. Normally, testers and other team members install a build or milestone to review it. However, sometimes you need the file versions used to create the build or milestone. For example, if a customer needs a fix for a particular release of software product, a developer needs to look at the source code that produced that release.

Before checking out a build or a milestone, make sure you check in any files you have been working on so the build or milestone does not overwrite those files.

To check out all the files with a particular build or milestone label:

1.	Select the appropriate subproject from the project tree.

2.	Select the Files tab below the right pane to list all the files.
The files list appears in the right pane.

3.	Use the Files in Project filter and the All Descendants  scope button, if appropriate.

4.	Select Files · Select All from the menu bar.

5.	Select Files · Check Out... from the menu bar.
The Check Out dialog opens.

6.	Select Version Label.

7.	Select the build or milestone’s label from the Version Label drop-down list box.

8.	Select the Force Check-out check box in case you have more recent versions of the selected files in your working directories.
Only the versions of files that match the label are checked out.

 Related Topics


Rename a Versions subproject
 Rename a subproject

To change the name of a subproject:

1.	Select the subproject from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties or Subproject Properties dialog opens.

3.	Type the new name in the Project Name text box. Use a maximum of 228 characters, but do not use forward slashes (/), backward slashes (\), or exclamation points (!).


Change prsoject/subproject description
 Change the description

To change the description of a subproject:

1.	Select the subproject from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties or Subproject Properties dialog opens.

3.	Select the Description tab.

4.	Type the new description (using a maximum of 255 characters) in the Description text box.


Change project version control options
 Change project version-control options

 When project security is enabled, only an administrator can change the project’s version control options. The maximum number of non-permanent versions can be overridden on a file by file basis by setting a file’s properties.

To change the version control options:

1.	Select the project from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties dialog opens.

3.	Select the Defaults tab.

4.	The number of non-permanent versions stored for any file in the project depends on the file’s storage type. By default, Versions stores a maximum of 32767 versions of files using either delta storage or omega storage.

To change the number of non-permanent versions stored:

a.	Select the Maximum or Limited option button for one of the storage types.

b.	If you selected Limited, type a maximum number of versions in the Limited text box.

c.	Repeat steps a and b for the other type of storage, if applicable.

5.	To stamp working files with the time the version is copied to the working directory, select Time Stamp Working File with Check-Out Time.
Clear this box to copy the time stamp of the version along with the version.
(The difference is whether the working file appears to be more recent than the copied version immediately or only after it has been updated.)

 Related Topics


Enable or disable Versions security
 Enable or disable security

 When project security is enabled, certain actions, such as deleting subprojects, can be performed only by administrators. If security is enabled, only an administrator can turn it off.

To enable or disable security:

1.	Select the project from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties dialog opens.

3.	Select the Security check box to restrict users’ actions or clear it to allow any user to perform any action.

 Related Topics


 Enable or disable the audit log

The audit log accumulates data about actions performed on projects, subprojects, files, and users. You select the Audit tab from the project window to view this data.

To enable or disable the collection of audit information:

1.	Select the project from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties dialog opens.

3.	Select the Audit Log check box to continue or clear it to stop adding entries to the audit log.


 Enable or disable e-mail

If you have a MAPI-compliant e-mail system, such as Microsoft Mail, you can attach versions of files to e-mail messages. You can also send the text of audit entries.

To enable or disable e-mail:

1.	Select the project from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties dialog opens.

3.	Select the Defaults tab.

4.	Select the Use Mail check box to use your e-mail application from Versions or clear it to stop using e-mail.

If you enable mail, you must close and reopen the project for your change to take effect.

NOTE:	If a user has the same name in multiple address lists (for example, Personal and Global Address Lists) Versions uses the first one it finds based on the Exchange settings. The Exchange addressing settings can be found in Tools · Options... · Addressing. The Addressing dialog allows a user to define the order in which Exchange searches lists when multiple lists are present.


 Enable or disable compression

The versions of files stored in the project vault can be compressed to save space.

To enable or disable compression:

1.	Select the project from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties dialog opens.

3.	Select the Defaults tab.

4.	Select the Use Compression check box to compress file versions or clear it to store files without compression.

 Related Topics


Require users to provide reasons for checking in files
 Require reasons for checking in files

 When project security is enabled, only an administrator can allow users to decide when to provide reasons for checking in files or force them to always provide reasons.

When users decide, they provide reasons by selecting Check In from the File menu. They bypass the reasons by selecting Check In from a context menu or clicking the Check In button on the toolbar.

When you require reasons, there is no quick check-in.

To require reasons or to allow users to decide:

1.	Select the project from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties dialog opens.

3.	Select the Defaults tab.

4.	Select the Force Check-in Reason check box to require reasons for checking in files from Versions or clear it to allow users to decide when to provide reasons.


 Enable or disable keyword expansion

Keywords are reserved words beginning and ending with a dollar sign ($). When used in a text file, these keywords are automatically expanded during file check-out to provide file and version information within the file.

To enable or disable keyword expansion:

1.	Select the project from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties dialog opens.

3.	Select the Defaults tab.

4.	Select the Keyword Expansion check box to use keyword expansion. Clear it to stop using keyword expansion.

 Related Topics


 Keywords

Keywords are reserved words beginning and ending with a dollar sign ($). When used in a text file, Versions replaces them with the data that they represent as the version containing the keywords is checked out. For example $Author$ is replaced by the name of the user who checked in the version. The complete list of keywords is:

$Archive$	Fully qualified path to the vault file (for example, C:\PROJECTS\SOURCE.VLT\W1.WF).

$Author$	User who checked the version in.

$Date$	Date and time stamp of the version.

$Header$	Combination of Archive, Revision, Date, and Author. Be aware that the keyword $Header$ is mistaken for a metacommand in MS Test or Visual Test.

$Locker$	User who has the file locked (if any).

$Log$	File change history (see below).

$NoKeywords$	Turns off keyword expansion for the rest of the file.

$Project$	Name of the project.

$Revision$	Version number.

$Subproject$	Name of the subproject.

$Workfile$	Unqualified name of the working file (for example, FOO.CPP).

$Log$ is the only keyword that can expand to a multiline entry. There is one line per version of the file, up to and including the version in question. Each line has the Version Number, Date, Author, and Reason for Check In, separated by tabs. For example:

$ Log:

3	08/10/95	JHawkins
2	08/05/95	LLevallee
1	07/01/95	JHawkins	Initial Version

$


Delete a Versions project
Delete a project

 When project security is enabled, only an administrator can delete a project. Deleting a project deletes the project database file and destroys the files in the project’s vault. There is no recovery, so use this procedure with caution. No working files are deleted.

To delete a project:

1.	Make sure that no users are currently using the project. (All project windows for this project should be closed.)

2.	Select Project · Delete... from the menu bar.
The Delete dialog opens.

3.	Indicate the path to the project database file (.stp), using the Drive, Directory, and File Name boxes.


Remove a subproject from version control
 Delete a subproject

 When project security is enabled, only an administrator can delete a subproject. When a subproject is deleted, you lose all the information stored in the project’s database file about it and all the file versions stored for it in the vault.

You can delete:

•	The selected subproject

•	All its child subprojects (instead of the subproject or along with the subproject)

•	Working files from the deleted subprojects’ working directories

Use this procedure with caution. You may recover the working files with a file recovery application, but the version control information is lost forever.

To delete a subproject:

1.	Select a subproject from the project tree.

2.	Select Project · Subproject · Delete... from the menu bar.
The Delete Subproject dialog opens.

3.	Select the Delete Vault Files check box to delete or clear it to keep the versions stored in the project vault. When cleared, the files becomes attached to the deleted subproject’s parent.

4.	Select the Delete Child Subprojects check box to remove the subproject’s subprojects and their files from version control. When cleared, the child subprojects become children of the deleted subproject’s parent.

5.	Select the Delete Working Files check box to delete the corresponding working files from their working directories. Clear the box to leave the working files undisturbed.


 Move a project

Versions does not automate the process of moving a project. You can, if the need arises, move the project manually. Be sure to move both the project database file and the project vault directory to the new location.

To move a project from one directory location to another:

1.	Before you begin:

•	Verify the name of the project database file (.stp), which appears in the title bar of the project window, then close the project.

•	Verify that no team members are currently logged on to the project.

2.	Using File Manager or Windows Explorer, locate the project database file to be moved. In the same directory, locate the .vlt directory that stores the vault files for the project database file. (For example, if the project file is project1.stp, the vault directory is project1.vlt.)

3.	Using any valid method, move the .stp file and the .vlt directory to the new location.

4.	Notify all team members of the new project location.

If you fail to move the vault, no files are visible in the files list for the Files Not In Project and Files to Check In filters. If a user attempts to check out a file, Versions cannot find it and displays a "File does not exist." error message.


 Check in a new version of a file

When a file is checked in, the contents of the working file are stored in the project vault as a new version of the file.

The first two procedures check files in quickly using the current workstation and project version control options and no reason for checking in the files. The last procedure displays the Check In dialog so you can change those options and/or supply a reason for check-in.

To check in a single file quickly using the project tree:

1.	Select a file from the project tree.

2.	Select Check In from the context menu.
The selected working file is added as a new version to the project vault.

To check in files quickly using the files list:

1.	Select one or more files from the files list.

2.	Click Check In [image] on the toolbar.
Or,
Select Check In from the context menu.
The selected working files are added to the project vault.

TIP: Use the Immediate Descendants [image] or All Descendants [image] buttons to check in files across multiple subprojects.

NOTE: Your Versions administrator can require you to always provide a check-in reason—even when you use a context menu or the toolbar button.

To check in files and set options for them:

1.	Select one or more files from the files list.

2.	Select Files · Check In... from the menu bar.
The Check In dialog opens.

3.	Select the Duplicate OK check box if it is OK to create a version that is identical to the previous one. Clear the box to reject a duplicate version.

4.	Select the Permanent check box to make the versions of these files permanent or clear the box to make the versions non-permanent.

5.	By default, text files use delta storage, and binary files use omega storage. If the selected files are text files that are large and change frequently, select the Force Omega check box to apply omega storage to these files.

6.	Select the Delete Working Files check box to delete the files from your workstation, storing them only in the project vault or clear the box to leave the working files in the working directory.

7.	Select the Keep Files Locked check box to keep your lock on the checked-in files. Clear the box to unlock the files as part of the check-in process.

8.	Type a generic reason for all the files in the Reason for Check-in text box using a maximum of 20K characters.
Or,
Select the Prompt for Reason for Each File check box.

9.	If retrieving these files later as a group or if retrieving this specific version of the one file being checked in will be important, type a label in the Version Label text box. For example, you may label a file as "technical review."

10.	If you are using Versions with StarTeam Workstation, click Show Defects if the selected files fix defects, then select those defects from the Defects Fixed list box. (You can double-click a defect to review or change its other properties.)

11.	Click OK.
The Enter Reason dialog opens if you selected the Prompt for Reason for Each File check box. Type reasons as necessary.

 Related Topics


 Check out the latest version of a file

When you check out a file using one of the following procedures, Versions copies the latest version of that file to the working directory for the subproject to which the file belongs. If a copy of that file is already in the working directory, it is overwritten unless that copy appears to be more recent than the checked in version. Then you are asked to confirm the check out. For example, if you check a file out, edit it, decide you don’t want your edits, and check out the file again, you are asked to confirm the check out.

The first two procedures check files out quickly using the current workstation options for check-out. The last procedure displays the Check Out dialog so you can change the Lock Status option or force a check-out when the latest version of a file is older than the working file.

To check out a single file quickly using the project tree:

1.	Select a file from the project tree.

2.	Select Check Out from the context menu.
The latest version of the selected file is checked out.

To check out files quickly using the files list:

1.	Select one or more files from the files list.

2.	Click Check Out [image] on the toolbar.
Or,
Select Check Out from the context menu.
The most recent versions of the selected files are checked out.

TIP: Use the Immediate Descendants [image] or All Descendants [image] buttons to check out files across multiple subprojects.

To check out files and set check-out options:

1.	Select one or more files from the files list.

2.	Select Files · Check Out... from the menu bar.
The Check Out dialog opens.

3.	Select the Latest Version option button.

4.	Select the Lock check box if you want to lock the files. Leave it cleared to retain each file’s current lock status.

5.	You can select Force Checkout to overwrite any working files, even if they are more recent than those being checked out.

 Related Topics


 Check out a previous version of a file

When you check out a file using one of the following procedures, Versions copies the selected version of that file to the working directory for the subproject to which the file belongs.

The first procedure allows you to compare versions before you select the one you want. However, you must use the current workstation options for check-out.

The second displays the Check Out dialog so you can change the Lock Status option or force a check-out when the latest version of a file is older than the working file. It allows you to check out versions of more than one file. However,

To check out a previous version of a single file:

1.	Display the history list by doing one of the following:

•	Right-click the name of the file from the files list.
Select Properties... from the context menu.
Then select the History tab from the File Properties dialog.

•	Select the name of the file from the project tree.
Then select the History tab below the project window’s right pane.

2.	To compare two versions to determine which of the two to check out:

a.	Select two previous versions from the history list.

b.	Select Compare from the History menu or context menu.

3.	Select the version to be checked out.

4.	Click Check Out [image] on the toolbar.
Or,
Select Check Out from the History menu or context menu.
The selected version is copied to the file’s working directory using the current workstation options for check-out.

To check out previous versions of more than one file:

1.	Select one or more files from the files list.

2.	Select Files · Check Out... from the menu bar.
The Check Out dialog opens. This allows you to check out the most recent version of the selected files. Or you can check out versions of those files with the same label or check-in date.

3.	Indicate what versions you want by selecting one of the following option buttons:

•	Version Label to check out the versions with a specific label, which you select from the Version Label drop-down list box.

•	As Of to check out the versions checked-in at or before the date and time you specify.

a.	To specify the date, type the date in the text box.
Or,
Click the button between the date and the time to use the calendar. Specify the date using the next and previous month buttons and the arrow keys.

b.	To specify the time, type the time in the text box, then select the AM or PM option button.

4.	Select Lock to lock each file as part of the check-out process. Clear it to preserve the current lock status of each file.

5.	Select Force Checkout to overwrite working files, even if they are more recent.

 Related Topics


 Sort the files list

Sort the files in the files list by name, extension, locker, exists, size, time stamp, maximum versions, description, author, subproject, or path. Most of the information sorts in alphanumeric order, based on the contents of the selected column. Timestamp sorts from most recent to earliest in time. Exists sorts No to Yes. Size and Max Vers (maximum versions) sorts numerically.

To sort the files in the files list:

1.	Click the appropriate column header. To change the sort order from ascending to descending (or vice versa), click the header a second time. The primary sort column’s header is underlined.

2.	Right-click another column header to perform a secondary sort.


 Sort the history list

Sort the versions in the history list by version number, time stamp, author, file size, or reason for check-in. Most information sorts in alphanumeric order, based on the contents of the selected column. Time stamps sort from most recent to earliest in time. Version numbers sort from highest to lowest.

To sort the versions in the history list:

1.	Click the appropriate column header. To change the sort order from ascending to descending (or vice versa), click the header a second time. The primary sort column’s header is underlined.

2.	Right-click another column header to perform a secondary sort.


 Lock or unlock a file

As a team member, you can lock files that are not already locked and unlock files for which you are the locker.

 When project security is enabled, only administrators can break the locks set by other team members. Otherwise any team member can break a lock, but this action should be taken only after talking with the file’s locker. If the project uses e-mail, the former locker is notified that the lock has been broken via e-mail.

You must lock a file before you:

•	Check it in

•	Change its maximum number of versions

•	Remove it from version control

•	Delete one of its versions

•	Purge non-permanent versions from it

•	Change the status of one of its versions from permanent to non-permanent or vice versa

Versions allows only one team member to lock a file at any given time. For example, your lock on a file prevents other team members from checking a new version of it into the project vault. As long as team members lock files before working on them, no one’s work is lost.

As a further safeguard, you can instruct Versions to attach the read-only attribute to all unlocked working files as they are checked out to your workstation. This makes it less likely that you will change a file you have not locked. Even when a team member works on an unlocked ASCII text file, all is not lost. You can use Files · Merge from the menu bar to save work that could otherwise be lost.

To lock or unlock a file:

1.	Select a file from the project tree.
Or,
Select one or more files from the files list.

2.	Select Lock or Unlock from the Files menu or a context menu.
Or,
Click Lock [image] or Unlock [image] on the toolbar.


 Break a lock

 When project security is enabled, only an administrator can break a lock. Even when security is disabled, it is dangerous to break someone’s lock on a file. The locker's work can be lost. Be sure to consult with the locker before completing the following procedure. If the project uses e-mail, the former locker is notified that the lock has been broken via e-mail.

To break a lock:

1.	Select a file from the project tree that is locked by another user.
Or,
Select one or more files from the files list that are locked by other users.

2.	Select Lock from the Files menu or a context menu.
Or,
Click [image] on the toolbar.
A message appears indicating who has the file locked and asking you, "Do you want to break the lock?"

3.	After reaching agreement with the current locker, click Yes.
If e-mail is enabled for the project and you are logged on to the mail system, the locker will be notified that you have broken the lock.


 Create a subproject branch

 When project security is enabled, only an administrator can create a subproject branch. You cannot branch the root subproject.

To create a subproject branch:

1.	From the project tree, select the subproject to be branched.

2.	Select Project · Subproject · Branch... from the menu bar.
The Branch Subproject dialog opens.

3.	Type the name for the branch in the Branch Name text box. Use a maximum of 228 characters, but do not use forward slashes (/), backward slashes (\), or exclamation points (!).

4.	Type the path to the working directory for the branch in the Working Directory text box.
Or,
Click Browse... to locate the working directory.
You can use the original working directory for the subproject or a new one.
Do not use Universal Naming Convention (UNC) pathnames or all users will be forced to use the same working directory (instead of local directories with identical pathnames). For example, the working directory c:\bigproj\working specifies a working directory on each user’s local c: drive, while the working directory \\domain\mydisk\working specifies that physical location for a single working directory shared by all team members.
If you specify a directory that does not exist, Versions can create the directory for you.

5.	Indicate what versions will be the initial versions in the branched subproject by selecting one of the following option buttons:

•	Latest Version to use the most recent versions.

•	Version Label to use the versions with a specific label, which you select from the Version Label drop-down list box.

•	As Of to use the versions checked-in at or before the date and time you specify.

a.	To specify the date, type the date in the text box.
Or,
Click the button between the date and the time to use the calendar. Specify the date using the next and previous month buttons and the arrow keys.

b.	To specify the time, type the time in the text box, then select the AM or PM option button.

6.	To branch the selected subproject and its children based on the above criteria, select the Branch Child Subprojects check box.
Leave it cleared to branch only the selected subproject at this time.

NOTE:	This check box is available only when all the child subprojects have working directories that are subdirectories of the selected subproject.

You use stcmd mrg at the command line (and not Files · Merge) to merge branched ASCII text files.

 Related Topics


 Find the source of a branched file

Versions provides the name of the file and the version number from which a particular file was branched.

To find the source of a branched file:

1.	Select the name of the file from the project tree or files list.

2.	From the context menu, select Properties.
The File Properties dialog opens.

3.	Select the History tab.
The name of the source file and its version number are at the bottom of the dialog.


Compare files or file versions in Versions
 Compare files or file versions

You can make any of the following comparisons between text files and/or text versions.

To compare two versions of a file:

1.	Display the history list by doing one of the following:

•	Right-click the name of the file from the files list.
Select Properties... from the context menu.
Then select the History tab from the File Properties dialog.

•	Select the name of the file from the project tree.
Then select the History tab below the project window’s right pane.

2.	Select two versions of a text file from the history list.

3.	Click Compare [image] on the toolbar.
Or,
Select Compare from the History menu or context menu.
Visual Diff, Versions’s differencing program, displays the two versions, indicating the differences with different colors.

4.	Select File · Exit from the Visual Diff menu bar to return to Versions.

To compare a version to the working file:

1.	Display the history list (as explained in step 1 above).

2.	Select one version of a text file from the history list.

3.	Click Compare [image] on the toolbar.
Or,
Select Compare from the History menu or context menu.
Visual Diff, Versions’s differencing program, displays the two, indicating the differences with different colors.

4.	Select File · Exit from the Visual Diff menu bar to return to Versions.

To compare two working files that are text files:

1.	Select a subproject from the project tree.

2.	Select the Files tab below the right pane.
The files list appears in the right pane.

3.	Select two text files from the files list. (You might need to click the Immediate Descendants or All Descendants button to see both files in the files list.)

4.	Click Compare [image] on the toolbar.
Or,
Select Compare from the Files menu or context menu.
Visual Diff, Versions’s differencing program, displays the two files, indicating the differences with different colors.

5.	Select File · Exit from the Visual Diff menu bar to return to Versions.

To compare a text file in the working directory with its most recently checked-in version:

1.	Select a subproject from the project tree.

2.	Select the Files tab below the right pane.
The files list appears in the right pane.

3.	Select a file from the files list.

4.	Click Compare [image] on the toolbar.
Or,
Select Compare from the Files menu or context menu.
Visual Diff, Versions’s differencing program, displays the two files, indicating the differences with different colors.

5.	Select File · Exit from the Visual Diff menu bar to return to Versions.


 Merge files

Suppose Ed locks and checks out version 7 of an ASCII text file to work on a new feature. Later Mary needs the file to fix defects for an inline which must ship before Ed’s feature is added. Even though Ed has already changed the file, he unlocks it for Mary, who does her work. Now both Mary and Ed have new versions whose ancestor is version 7 of the file. Mary checks in her work as version 8 of the file.

Now Ed has a problem. He cannot check in his work because version 8 is more recent that the version he checked out. Also, if he checks out version 8, he loses his work. Fortunately, Ed knows that Versions allows users to merge two versions of an ASCII text file. Ed locks version 8 and uses Files · Merge to merge his file with Mary’s. Versions uses version 7, the common ancestor of both files as a basis for determining what has changed. The output from the merge becomes Ed’s new working file. He verifies the working file (consulting with Mary if necessary) before he checks it in.

To merge an outdated ASCII text file with the most recently checked in version:

1.	Select the name of the file from the files list.

2.	Lock the file by doing one of the following:

•	Click Lock [image].

•	Select Lock from the Files menu or a context menu.

3.	Select Files · Merge.
Versions warns you when the files contain differences (conflicts) and notifies you when the files are the same.
After the merge, a merged file, with the differences between the two files clearly marked, becomes your working file.

4.	Edit the merged file to review the changes and resolve conflicts before checking the file in.

Sample of conflict output in merged file:

>>>> === An editing conflict was detected in lines 10 through 10 ===

>>>> The original (root) file contains the following:

BUFFERS=10,0

>>>> The last checked-in version contains the following:

BUFFERS=20,0

>>>> The current working file contains the following:

BUFFERS=30,0

>>>> === End of the conflict section ===

You use stcmd mrg at the command line (and not Files · Merge) to merge branched ASCII text files.

 Related Topics


Send a file as an e-mail attachment
 Send one or more files

You can send the most recently checked-in versions of the selected files as e-mail attachments.

To send a file via e-mail:

1.	Select the name of the file from the project tree or files list.

2.	Click Send [image] on the toolbar.
Or,
Select Send To... from the Files menu or a context menu.
The Send To dialog opens.

3.	Select one or more project users from the Recipients list. If you don’t select any users, the mail message goes to all of them.

4.	Click Send Now to send the message, which has the subject "Files from Versions project: <project name>" and contains only the attached file.
Or,
Click Goto Mail... to edit the message inside your e-mail application. Then send the message via that application.

 Related Topics


Send a version as an e-mail attachment
 Send a version

You can send the selected version as an e-mail attachment.

To send a version via e-mail:

1.	Display the history list by doing one of the following:

•	Right-click the name of the file from the files list.
Select Properties... from the context menu.
Then select the History tab from the File Properties dialog.

•	Select the name of the file from the project tree.
Then select the History tab below the project window’s right pane.

2.	Select the version of the file to be sent from the history list.

3.	Click Send [image] on the toolbar.
Or,
Select Send To... from the History menu or context menu.
The Send To dialog opens.

4.	Select one or more project users from the Recipients list. If you don’t select any users, the mail message goes to all of them.

5.	Click Send Now to send the message, which has the subject "Version from Versions project: <project name>" and contains only the attached version.
Or,
Click Goto Mail... to edit the message inside your e-mail application. Then send the message via that application.

 Related Topics


 Change a file description

To change the description:

1.	Select a file (that you have locked) from the project tree. Then select Properties... from the Project menu or the context menu.
Or,
Select a file (that you have locked) from the files list. Then select Properties... from the Files menu or the context menu.
The File Properties dialog opens.

2.	Type a new description (using a maximum of 255 characters) in the File Description text box.


Change the maximum number of versions
 Change the maximum number

The number of non-permanent versions stored for any file in the project depends on the file’s storage type. By default, Versions stores a maximum of 32767 versions of files using either delta storage or omega storage.

 When project security is enabled, only an administrator can change the maximum number of non-permanent versions to be stored for a file. Even when security is disabled, the person changing the maximum number must first lock the file.

To change the maximum number of versions for a file:

1.	Select one or more files from the files list.

2.	If you are not the locker of these files, select Lock from the Files menu or the context menu.

3.	Select Files · Maximum Versions... from the menu bar.
The Maximum Versions dialog opens.

4.	Select the Maximum or Limited option button for one of the storage types.

5.	If you selected Limited, type a maximum number of versions in the Limited text box.

6.	Repeat steps 4 and 5 for the other type of storage, if applicable.


Change a version's permanent/non-permanent status
 Change a version’s status

 When project security is enabled, only an administrator can change a version’s status from permanent to non-permanent (or vice-versa). Even with security disabled, the file must be locked before a version's status can be changed.

To change a version’s status:

1.	Select the file from the project tree or the files list.

2.	If you are not already the locker of the file, select Lock from the project-tree context menu.

3.	Display the history list by doing one of the following:

•	Right-click the name of the file from the files list.
Select Properties... from the context menu.
Then select the History tab from the File Properties dialog.

•	Select the name of the file from the project tree.
Then select the History tab below the project window’s right pane.

4.	Select the version for which the status is to be changed.

5.	Select Permanent or Not Permanent from the History menu or the history-list context menu.


Change reason for check-in
 Change the reason for check-in

You can change a version’s reason for check-in only if you have the file locked.

To change the reason why a version was checked in:

1.	Display the history list by doing one of the following:

•	Right-click the name of the file from the files list.
Select Properties... from the context menu.
Then select the History tab from the File Properties dialog.

•	Select the name of the file from the project tree.
Then select the History tab below the project window’s right pane.

2.	Select the version for which the reason has changed.

3.	Select Properties... from the History menu or the context menu.
The Version Properties dialog opens.

4.	Type a new reason in the Reason for Check-in text box using a maximum of 20K characters.


 Delete a version

 When project security is enabled, only an administrator can delete a version of a file from the project vault. Use this procedure with caution. The history information for all deleted versions remains in the project database, even though the deleted versions are not recoverable. In the file’s history display, the history information for deleted versions is dimmed.

To delete versions:

1.	Select the file from the project tree.

2.	Select the History tab below the right pane.
The history list appears in the right pane.

3.	Select one or more versions to be deleted.

4.	Select History · Delete from the menu bar.
Or,
Press Delete.
For permanent versions, Versions asks for confirmation.


 Purge non-permanent versions

 When project security is enabled, only an administrator can purge the non-permanent versions from the file. Even when security is disabled, the person purging a file must have locked it first. The history information for all deleted versions remains in the project database, and the deleted versions are dimmed in the file’s history display.

To purge non-permanent versions from files:

1.	Select one or more files from the files list.

2.	Select Files · Purge from the menu bar.
The permanent versions and the most recently checked in version are not deleted during a purge.


 Delete a file

 When project security is enabled, only an administrator can remove a file from version control. Even when security is disabled, you must lock the file before you can remove it. Removing a file destroys all the information about its version history and audit entries. Use this procedure with caution.

To remove one or more files from version control:

1.	Select a subproject from the project tree.

2.	Select the Files tab below the right pane.
The files list appears in the right pane.

3.	Select the files to be removed from version control from the files list.

4.	Select Files · Delete... from the menu bar.
Or,
Press Delete.
The Delete Files dialog opens.

5.	Select the Delete Working Files check box to delete the corresponding working files from their working directories. Clear the box to leave the working files undisturbed.


 Open a file

You can open any file from the project window as long as that file is executable (.bat, .exe, etc.) or is associated with an application via Windows. For example, .doc files are associated with Word for Windows.

To open a file:

•	Double-click the name of the file in the project tree or files list.

Or,

1.	Select a file from the project tree or files list.

2.	Select Open from the Files menu or a context menu.


 Edit a file

You can edit any text file in Windows Notepad or in the editor you selected as a workstation option.

To edit a file:

1.	Select a file from the project tree or files list.

2.	Click Edit [image] on the toolbar.
Or,
Select Edit from the Files menu or a context menu.


 Delete a working file

Working files can be deleted from the working directory:

•	As part of removing a file or subproject from version control.

a.	Select the project file from the files list.

b.	Select Files · Delete... from the menu bar.
Or,
Press Delete.

•	As part of the check-in process. This can be set as a workstation option or selected from the Check In dialog.

a.	Select the Files · Check In... from the menu bar.

b.	Select the Delete Working Files check box.

•	If the working file had not been added to the project, select the Files Not In Project filter, select the file from the files list, then press Delete.

•	Using your operating system.

 Related Topics


 Add a user to a project

Any number of users can access a project, but only after they have been added to the list of team members.

 When project security is enabled, only an administrator can add users. If a user is added when project security is disabled, that user has a blank password when security is enabled until an administrator or the user changes it to a real password. As you add a user to the project (and if the project has e-mail enabled), Versions automatically sends e-mail notification to that user about being added to the project team.

To add a user to a project:

1.	Select the Team tab below the right pane.
The team list appears.

2.	Select Team · New User... from the menu bar.
The New User dialog opens.

3.	Type the name that will allow the user to log on to the project in the User Name text box. This is usually the user’s logon name for the network. Select this name carefully, because it cannot be changed.

4.	Type the user’s e-mail name in the Full Name text box to use MAPI-compliant e-mail efficiently from Versions. For example, when a new user is added to a project that has mail enabled, Versions sends a welcome mail message to that user.
When using Microsoft Exchange, the full name and the Exchange profile name should be the same. Otherwise Microsoft Exchange returns an error message each time you log on to the Versions project. If this occurs, create a new Exchange profile with the same name as your Versions user name.

5.	If project security is enabled, type the password that will allow the user access to the project in the Password check box.
Passwords are case-sensitive and must contain at least six characters.
Asterisks appear instead of the characters you type.

6.	If you typed a password, retype it in the Confirm text box to prove it was typed correctly at step 5.

7.	Select the Administrator check box if this user will have administrator privileges.

8.	Select the Force Change Password check box so the user must change the password during the first logon.


Change a user's password
 Change a user’s password

 When project security is enabled, an administrator can change a user’s password. So can that user. When security is disabled, passwords are not used and the Password and Confirm text boxes are disabled.

To change a user’s password:

1.	Select the Team tab below the right pane.
The team list appears.

2.	Double-click the user.
Or,
Select the user. Then select Properties... from the Team menu or the context menu.
The User Properties dialog opens.

3.	Type the new password in the Password text box.
Passwords are case-sensitive and must contain at least six characters.
Asterisks appear instead of the characters you type.

4.	Retype the password in the Confirm text box to prove it was typed correctly at step 3.

 Related Topics


Change a user's e-mail name
 Change a user’s e-mail name

Versions uses the full name you specify for a user to log on to e-mail and send mail messages. When using Microsoft Exchange, the full name and the Exchange profile name should be the same. Otherwise Microsoft Exchange returns an error message each time you log on to the Versions project. If this occurs, create a new Exchange profile with the same name as your Versions user name.

To change the user’s e-mail name:

1.	Select the Team tab below the right pane.
The team list appears.

2.	Double-click the user.
Or,
Select the user. Then select Properties... from the Team menu or the context menu.
The User Properties dialog opens.

3.	Type the new e-mail name in the Full Name text box, then click OK.


 Change administrator status

 When project security is disabled, no one’s administrator status can be changed. When security is enabled, only an administrator can change a user’s administrator status. For example, the administrator may want to add other administrators to the project.

To change a user’s status:

1.	Select the Team tab below the right pane.
The team list appears.

2.	Select the user from the team list.

3.	Select Properties from the Team menu or the context menu.
 The User Properties dialog opens.

4.	Select the Administrator check box to add the user as an administrator. Clear it to remove administrator status from the user.


 Force password change

 When security is enabled, only an administrator can force a user to change a password.

To force a user to change a password:

1.	Select the Team tab below the right pane.
The team list appears.

2.	Double-click the user.
Or,
Select the user. Then select Properties... from the Team menu or the context menu.
The User Properties dialog opens.

3.	Select the Force Password Change check box.
The user sees the Change Password dialog at the next logon. Then this check box becomes automatically cleared.


 Sort the users

Sort the users in the team list by user (logon) name, full (e-mail) name, or administrator status. Most information sorts in numeric or alphanumeric order, depending on the contents of the selected column. The administrator status column sorts the users into administrators and non-administrators.

To sort the entries in the team list:

1.	Click the appropriate column header. To change the sort order from ascending to descending (or vice versa), click the header a second time. The primary sort column’s header is underlined.

2.	Right-click another column header to perform a secondary sort.


 Delete a user from a project

 When project security is enabled, only an administrator can delete a user from a project.

To delete a user from the project:

1.	Select the Team tab below the right pane.
The team list appears.

2.	Select the user from the team list.

3.	Select Team · Delete from the menu bar.
Or,
Press Delete.


 View the audit log

The audit log shows the actions performed for the subproject or file selected from the project tree.

To view the audit log:

1.	From the project tree, select the subproject or file.

2.	Select the Audit tab below the right pane.
The audit log appears in the right pane.

3.	Select a filter from the Filter drop-down list box to display only the entries of interest.

4.	Click a column header to sort the displayed entries based on the value in that column. The sort order for most columns is ascending alphanumeric. To change the sort order from ascending to descending (or vice versa), click the column header a second time. The primary sort column’s header is underlined.

5.	Right-click another column header to perform a secondary sort.


 Sort the entries

Sort the entries in the audit log by type, event, time stamp, user, description, or owner. Most information sorts in numeric or alphanumeric order, depending on the contents of the selected column. Time stamps sort from most recent to earliest in time.

To sort the entries in the audit log:

1.	Click the appropriate column header. To change the sort order from ascending to descending (or vice versa), click the header a second time. The primary sort column’s header is underlined.

2.	Right-click another column header to perform a secondary sort.


Send the text of audit entries
 Send audit entry descriptions

You can send the text of the descriptions for the selected audit entries as an e-mail message.

To send audit entries via e-mail:

1.	Select the name of a subproject or file from the project tree.

2.	Select the Audit tab below the right pane.
The audit log appears in the right pane.

3.	Select the audit entries to be sent from the audit log.

4.	Click Send [image] on the toolbar.
Or,
Select Send To... from the Audit menu or context menu.
The Send To dialog opens.

5.	Select one or more project users from the Recipients list. If you don’t select any users, the mail message goes to all of them.

6.	Click Send Now to send the message, which has the subject "Audit entries from Versions project: <project name>" and contains descriptions of the selected entries.
Or,
Click Goto Mail... to edit the message inside your e-mail application. Then send the message via that application.

 Related Topics


 Clear the audit log

The audit log shows the actions performed on the subproject or file selected from the project tree. You may occasionally want to empty it or partially empty it.

 When project security is enabled, only an administrator can clear the audit log.

To delete entries from the audit log:

1.	Select the root subproject from the project tree.

2.	Select the Audit tab.
The Audit Log appears in the right pane.

3.	Select Audit · Clear Log... from the menu bar.
The Clear Audit Log dialog opens.

4.	Do one of the following:

•	To clear the entire log, leave the All option button selected.

•	To delete everything before a certain date, select the As Of option button.

a.	To specify a date, use the calendar (available from the list box), the next and previous month buttons, and the arrow keys.

b.	To specify a time, type the time in the text box, then select the AM or PM option button.


 Create reports

Versions offers a great variety of reports for files, versions, team members, and audit entries. Before you create a report, limit what is displayed in the right pane to fit that report’s purpose. Then, if appropriate, select only the displayed items you want in the report.

Sorting, grouping, and selecting items in the right pane of the Versions project window affects report generation. To produce a report based on a specific sorting or grouping of Versions data, or to produce a chart based on a limited or expanded set of files, arrange the data in the Versions project window before you generate the chart.

For example, a team leader might want a report of all the files (and their versions) in a subproject. She selects the subproject name from the project tree. If the subproject has child subprojects, she clicks the All Descendants scope button. Then she selects Files · Reports... and creates a File Detail Report.

To create reports:

1.	Select Reports... from the Files, History, Team, or Audit menus.
The Reports dialog displays a list of possible reports in the Reports list box and a description of each report in the Report Description list box.

2.	Select a report from the Reports list box.

3.	To create the report using only the items selected from the right pane, select the Currently Selected option button in the Chart Information group box.
Or,
To use all the items displayed in the right pane, select the Select All option button.

4.	Click Preview to review the report.

5.	Click Print to print the report.

6.	You can repeat steps 2 through 5 to create more reports. Click Close when you are done.

 Related Topics


 Available reports

You can preview and print a number of different reports, depending on the selected tab.

Tab	Name of Report	Description of Report
Files	File Detail	Lists files and their version histories.
	File Summary	Lists file summary information.
History	Version History	Lists selected version entries.
Team	User List	Lists selected user entries as displayed in team list
Audit	Audit List	Lists all audit entries as displayed in the audit log.


Send a report as an e-mail attachment
 Send a report

You can send a report via e-mail as an attached file in a specified format, such as that of an Excel or Lotus 1-2-3 spreadsheet or a Word for Windows document.

To send a report via e-mail:

1.	Select Reports... from the Files, History, Team, or Audit menus.
The Reports dialog displays a list of possible reports in the Reports list box and a description of each report in the Report Description list box.

2.	Select a report from the Reports list box.

3.	Select the Currently Selected option button in the Report Information group box to create the report using only the items selected from the right pane. Select the Select All option button to use all the items displayed in the right pane.

4.	Click Preview to review the report.

5.	Click Send Report [image] to send the report.
The Export dialog opens.

6.	Select a format from the Format drop-down list box.

7.	Make sure that Microsoft Mail (MAPI) appears in the Destination drop-down list box, then click OK.

8.	Depending on the selected format, another dialog may open so you can select additional options, then click OK.
For example, the Number and Date Format dialog opens when you select Data Interchange Format (DIF). On the other hand, if the selected format is Rich Text Format, no dialog opens.

Finally, the Send Mail dialog opens.

9.	Provide addresses, a subject, and an explanatory message, then click Send.
Versions sends the report in the selected format to the addressees.

 Related Topics


 Write a report to a file

You can write a report to a disk file in a specified format, such as that of an Excel or Lotus 1-2-3 spreadsheet or of a Word for Windows document.

To write a report to a file:

1.	Select Reports... from the Files, History, Team, or Audit menus.
The Reports dialog displays a list of possible reports in the Reports list box and a description of each report in the Report Description list box.

2.	Select a report from the Reports list box.

3.	Select the Currently Selected option button in the Report Information group box to create the report using only the items selected from the right pane. Select the Select All option button to use all the items displayed in the right pane.

4.	Click Preview to review the report.

5.	Click Save Report as File {bmp rptexp.mrb} to write the report to a file.
The Export dialog opens.

6.	Select a format from the Format drop-down list box.

7.	Select Disk File from the Destination drop-down list box, then click Save.

8.	Depending on the selected format, another dialog may open so you can select additional options, then click OK.
For example, the Number and Date Format dialog opens when you select Data Interchange Format (DIF). On the other hand, if the selected format is Rich Text Format, no dialog opens.

Finally, the Choose Export File dialog opens.

9.	Provide a name and path for the disk file, then click OK.
Versions writes the report to the selected file.

 Related Topics


 Create charts

Versions offers a great variety of charts for files, versions, team members, and audit entries. Before you create a chart, limit what is displayed in the right pane to fit that chart’s purpose. Then. if appropriate, select only the displayed items you want to chart.

Sorting, grouping, and selecting items in the right pane of the Versions project window affects chart generation. To produce a chart based on a specific sorting or grouping of Versions data, or to produce a chart based on a limited or expanded set of files, arrange the data in the Versions project window before you generate the chart.

For example, a team leader might want a chart that shows who originally checked in each file in a subproject. He selects the subproject name from the project tree. If the subproject has child subprojects, he clicks the All Descendants scope button. Then he selects Files · Charts... and creates an Authors Report.

If he is interested in a chart that shows who checked in versions of a particular file, he selects that file from the project tree. Then he selects Files · Charts... and creates a Version Authors Report

To create charts:

1.	Select Charts... from the Files, History, Team, or Audit menus.
The Charts dialog displays a list of possible charts in the Charts list box and a description of each chart in the Chart Description list box.

2.	Select a chart from the Charts list box.

3.	If the Time Series drop-down list box is enabled (as it is for some charts), select Daily, Weekly, or Monthly as the time period for the charted information.

4.	To create the chart using only the items selected from the right pane, select the Currently Selected option button in the Chart Information group box.
Or,
To use all the items displayed in the right pane, select the Select All option button.

5.	Click Chart to display the chart.
Once the chart appears, you can use Chart help to change the chart in a variety of ways.
For example, click Print [image] on the toolbar to print the chart.

6.	You can repeat steps 2 through 5 to create more charts. Click Close when you are done.

 Related Topics


 Available Charts

You can display a number of different charts, depending on the selected tab.

Tab	Name of Chart	Description of Chart
Files	File Authors	Pie chart; number of files added to project by each user.
	File Lockers	Pie chart; number of files locked by each user.
	File Sizes	Double series bar chart; compares sizes of working files (first series) to sizes of project vault files (second series).
	File Versions	Bar chart; number of versions currently stored in the vault for each file.
	Files in Subprojects	Pie chart; number of files in each subproject.
History	Version Authors	Pie chart; number of versions by each author.
	Version History Changes	Triple series area chart; number of lines added, changed, and deleted for each version.
	Version Percentage of Change	Line chart; percentage of change in version.
	Version Sizes	Line chart; size of each version
Team	Admin Users	Pie chart; numbers of administrators and non-administrators
	User Types	Pie chart; number of users and groups
Audit	Audit Entry Events	Pie chart; number of entries for each event.
	Audit Entry Owners	Pie chart; number of entries for each owner.
	Audit Entry Types	Pie chart; number of entries for each type (Information, Warning, and Error) .
	Audit Entry Users	Pie chart; number of entries for each user.


 Confirm actions and warnings

You can confirm:

•	Deletions of versions and working files and the removal of files and subprojects from version control.

•	Moves of files and subprojects in the project tree.

•	The overwriting of working files.

•	Warnings.
Without warning confirmation, Versions does not display warnings.

To confirm actions and warnings:

1.	Select Options · Workstation... from the menu bar.
The Workstation Options dialog opens.

2.	Select the boxes for the items to be confirmed.


Change workstation version control options
 Change version control options

Workstation options are user-selectable choices for the behavior of Versions on a specific workstation. Several of these options are for version control. You can override these options as you check a particular file in or out by selecting Files · Check In... or Files · Check Out... from the menu bar and using either the Check In or Check Out dialog.

To set version control options for the workstation:

1.	Select Options · Workstation... from the menu bar.
The Workstation Options dialog opens.

2.	Select the Defaults tab.

3.	To lock files as you check them out, select the Lock Files on Check-Out check box. Otherwise the file’s current lock status is preserved.

4.	To retain your lock on a file after a check in, select Keep File Locked on Check-in.
Otherwise the working file is automatically unlocked.

5.	To delete the working file as part of the check-in process, select Delete Working Files on Check-in.
Otherwise the file is left in the working directory.

6.	To protect yourself from accidentally updating working files that you do not have locked, select Mark Unlocked Working Files Read-only.
Otherwise, you may make changes to unlocked files. (ASCII text files accidentally changed in this way can be merged with the most recent checked-in version using Files · Merge from the menu bar.)

 Related Topics


Control the Versions scope buttons
 Control the scope buttons

By default, any time you change from one subproject to another or from one tab to another, the No Descendants scope button becomes automatically selected. This saves you the time Versions would take to scan files and audit entries associated with the selected subproject’s descendants. However, a workstation option allows you to stop this automatic change.

To control which scope button is selected after a subproject or tab change:

1.	Select Options · Workstation... from the menu bar.
The Workstation Options dialog opens.

2.	Select the Display tab.

3.	Select or clear the Reset Scope Selection on Change check box.
When selected, the No Descendants scope button becomes selected every time you change a tab or subproject.
When cleared, only you change the scope buttons.


Display or hide the Versions toolbar
 Display or hide the toolbar

To display or hide the toolbar:

1.	Select Options · Workstation... from the menu bar.
The Workstation Options dialog opens.

2.	Select the Display tab.

3.	Select or clear the Display Toolbar check box.


Display or hide the Versions status bar
 Display or hide the status bar

To display or hide the status bar:

1.	Select Options · Workstation... from the menu bar.
The Workstation Options dialog opens.

2.	Select the Display tab.

3.	Select or clear the Display Status Bar check box.


Display or hide the Versions splash screen
 Display or hide the splash screen

To display or hide the splash screen:

1.	Select Options · Workstation... from the menu bar.
The Workstation Options dialog opens.

2.	Select the Display tab.

3.	Select or clear the Display Splash Screen check box.


 Display projects at startup

You can reopen the projects that were open as you last exited Versions or startup Versions with no projects open.

To reopen projects at startup:

1.	Select Options · Workstation... from the menu bar.
The Workstation Options dialog opens.

2.	Select the Display tab.

3.	To reopen projects as they appeared when you last exited Versions, select the Restore Projects at Startup check box. Clear the box to display an empty main window at startup.


 Change refresh interval

The data in open project windows is updated, or refreshed, at regular intervals as well as when you select Windows · Refresh from the menu bar.

To specify refresh options:

1.	Select Options · Workstation... from the menu bar.
The Workstation Options dialog opens.

2.	Select the Display tab.

3.	Type a number of minutes (from 1 to 90) in the Automatic Refresh Rate text box.
Or,
Use 0 to prevent automatic refreshes from occurring.
(The default is 30 minutes.)


 Run or edit .bat and .cmd files

If you double-click a file name in the files list, Versions runs that file (if it is executable) or opens it in the application associated with it. For example, double-clicking an .exe file runs it, and double-clicking a .doc file displays it in Word for Windows.

For .bat and .cmd files, you can specify whether you want the double-click to execute the file or open it in a text editor.

To specify what happens when you double-click .bat and cmd files:

1.	Select Options · Workstation... from the menu bar.
The Workstation Options dialog opens.

2.	Select the Display tab.

3.	To edit .bat and .cmd files, select the Edit .bat and .cmd on Double-click check box. Clear the box to run files with these extensions.


Change text editor for Versions
 Change text editor

By default, the text editor used with Versions is Notepad (notepad.exe).

To change the text editor:

1.	Select Options · Workstation... from the menu bar.
The Workstation Options dialog opens.

2.	Select the Tools tab.

3.	Type the path to a text editor.
Or,
Click Browse... to locate an editor.


 Compress or decompress vault files

Compress or decompress individual or groups of vault files.

To compress or decompress vault files:

1.	Select one or more files from the files list.

2.	Select Files · Compress Vault File or Files · Decompress Vault File.

 Related Topics


 Questions and answers

Q:	How can I improve Versions’s performance?

A:	Do some of the following:

•	Organize your subprojects for efficient access. It is best to make the project hierarchy as flat as possible. Wherever you can, make subprojects siblings rather than parent and child. Especially when accessing Versions remotely, the fewer files that need to be scanned to determine whether they need to be checked in and so forth, the better.

•	Pack the project database file (.stp) using the Project Maintenance utility.

•	Use vault file compression.
(Select Project · Properties…, then the Default tab. Select the Use Compression check box.)

•	Disable the audit log.
(Select Project · Properties…, then the Name tab. Clear the Audit Log check box.)

Q:	How does Versions know what files are ready to check in or out?

A:	Versions uses a workstation database (stwork20a.db) and the time stamp on files to determine what you should check in or out.

Q:	What if the workstation database is corrupted or lost?

A:	If you lose the workstation database file (stwork20a.db), Versions recreates it automatically. To resynchronize your workstation information, check out your project files again.

Q:	Do I need to do backups?

A:	Versions project vaults are not a replacement for backups. In fact, it is critical that you back up the following:

•	Project database files (.stp)

•	Their vault directories (.vlt)

•	The files within the .vlt directories

In certain environments, open files are not backed up. Because a wide audience can access a Versions database project file at various times of day, a project may always be open for at least one user.

To make sure that project database files (.stp) are backed up even if they are open, copy them and their associated vault directories (.vlt) and files to another server location and have that location backed up instead. Perform this copying process before the backup process or automate it using a the operating system’s scheduling service.

Q:	How is your project information stored? Is it stored in a known database format or do you store it in a proprietary format?

A:	We are using the Access database format to store much of the data including (but not limited to) audit information. Actual file versions are stored in StarBase's proprietary file structure.

Q:	Is your Versions product integrated with the Visual Basic, Visual C++, or Delphi environments?

A:	Versions supports any file-based development environment. You can launch your development environment from within Versions as from File Manager or Windows 95 Explorer.

Versions has been integrated with some other IDEs, such as Microsoft's Developer's Studio. Also, Versions’s command-line utility allows you to perform version control functions if the development environment allows you to add tools to menus.

Q:	How does your product deal with shared files? Most of our projects have a set of files in common.

A:	Since Versions permits you to have more than one project, you can put the shared files in a single project (named, for example, Shared Files). When you open a project that uses the files in the Shared Files project, you can open the Shared Files project as well. You perform actions, such as check-ins and check-outs, in two separate projects.

The alternative is to include all your "projects" in one Versions project. Each of your projects becomes a subproject of the one large project. Shared Files would be one of those subprojects.

Q:	I am currently unable to check in changes I have made to a file. What is the problem?

A:	You need to lock the file. A number of different operations require that the file be locked. For a complete list of these operations, see Lock or unlock a file for more details.

Q:	Can I bypass the Log On dialog when security is disabled?

A:	You cannot bypass the Log On dialog. Versions needs to know your user name to note author information and monitor locker data. The logon name you use for one session becomes the default logon name for the next session. This allows you to log on to a project  that does not enforce security quickly by pressing Enter or clicking OK.

Q:	What about error messages?

A:	Here are some common error messages and their resolutions.

Disk write error

This is not a Versions error message, but you may see it (or similar error messages) if the environment variable called TEMP on your workstation points to one of the following:

•	An invalid location

•	A location that is low on disk space

Versions uses disk space in that location to perform operations.

Q:	When I try to check in changes that I have made to one of my files I get this message:  "File in use by another, try again later." I know no one else is using the file. Why do I get this error message? What can I do so that I can check this file in?

A:	This error message occurs as a result of an abnormal interruption in the check-in or check-out process. As a part of these processes, Versions creates temporary files in the project vault directory (.vlt directory).

When the process completes successfully, Versions automatically deletes these files. When the process is interrupted, these files need to be deleted manually.

Use the File Manager or Windows 95 Explorer to look for files in the project vault directory with unusual names. Vault files usually have names like vv1.vvf or vv10.vvf.

The abnormal file names are similar to __cvn___. or have an underscore (_) in the last position of the file extension. They are generally 0 bytes in length. Delete these temporary files. Sometimes you may have to exit Versions and restart Windows before the error is resolved.


Send note to team members
 Send a note to team members

You can send a note to one or more team members using Versions.

To send a message:

1.	Select Project · Send Note To... from the menu bar.
The Send Note To dialog opens.

2.	Select one or more recipients from the Recipient List.

3.	Click Goto Mail....
Continue writing the message using your MAPI-compliant e-mail application.


 Create directory structure

If you want to add files to an existing project, you need to have the correct working directory on your workstation. Only from that directory can you add files to the project.

To create the correct directory structure on your workstation:

1.	Select the subproject from the project tree that you need the working directory for.

2.	Select Project · Subproject · Create Directory Structure... from the menu bar.
Versions automatically creates the path to the working directory for the selected subproject. It also creates the working directories for the subprojects of your selection.


 Specify your own working directory

If the Versions administrator does not require you to use the default working directory for working files on your workstation, you can specify a convenient directory as a working directory. For example, you might use a directory with a shorter path or different drive letter than the default.

To create an alternative working directory for your workstation:

1.	Select the subproject from the project tree.

2.	Select Properties... from the Project menu or the context menu.
The Project Properties or Subproject Properties dialog opens.

3.	Select the Alternative option button. (It is disabled if your Versions administrator does not allow an alternative for this working directory.)

4.	Type the path for the working directory you will use in the text box or click Browse… to locate that directory.
If the directory you specify does not exist, Versions creates it for you.


 Enable or disable alternative working directories

 When project security is enabled, only an administrator can enable or disable the use of alternative working directories.

You can do either of the following:

•	Require all users to store working files in the default working directory for a subproject

•	Allow each user to specify a convenient directory as a working directory. For example, someone might use a directory with a shorter path or different drive letter than the default.

To enable or disable alternative working directories:

1.	Select the subproject from the project tree.

2.	Select Properties... from the Project menu or the context menu.
Or,
Press Alt+Enter.
The Project Properties or Subproject Properties dialog opens.

1. 	Select the Force Default Working Directories check box to require all users to create the same working directories on their workstations.
Or,
Clear the box to allow users to specify their own working directories.


 Add a group to a project

A group consists of any number and combination of team members. You use groups to assign privileges to many users at one time instead of each user individually.

Suppose you create a group called Testers that contains all the team members who will be testing the product. Suppose you also have a security template that allows team members to delete files. By assigning the Testers group to that security template for the Automated Testing subproject, you give each tester the ability to delete files in that subproject. As testers come and go, you add or delete their names from the Testers group.

 When project security is enabled, only an administrator can create or modify groups.

To create a group:

1.	Select the Team tab below the right pane.

The team list appears.

2.	Select Team · New Group... from the menu bar.

The New Group dialog opens.

3.	Type the name for the group in the Name text box.

4.	Click Add....

The Add Users dialog opens.

5.	Select one or more users then click OK.

 Related Topics


 Control group membership

 When project security is enabled, only an administrator can add users to or remove them from a group.

You can add and remove users using either the Group Properties dialog or the Group tab of the User Properties dialog.

Use the Group Properties dialog to make one or more membership changes to a group. For example, several users might need to be added to an existing group at one time.

Use the Group tab of the User Properties dialog to modify the list of groups to which a user belongs. For example, a new team member might need to be added to several groups at once.

To change an existing group’s membership list:

1.	Select the Team tab below the right pane.
The team list appears.

2.	Double-click the group to be modified.
Or,
Select the group then select Properties... from the Team or context menu.
Or,
Press Alt+Enter.
The Group Properties dialog opens.

3.	To add users: Click Add... to select additional members from the Add Users dialog (which lists all the team members who are not in this group).
Or,
To remove users: From the Members list box, select one or more users to be deleted, then click Remove.

To change the list of groups to which a user belongs:

1.	Select the Team tab below the right pane.
The team list appears.

2.	Double-click the user to be modified.
Or,
Select the user then select Properties... from the Team or context menu.
The User Properties dialog opens.

3.	Select the Group tab.
The Group dialog opens.

4.	To add groups: Click Add... to select additional groups from the Add Groups dialog (which lists all the groups that do not include this user yet).
Or,
To remove groups: From the Membership list box, select one or more groups to which the user should not belong. Then click Remove.


 Create a security template

 When project security is enabled, only an administrator can create a security template which defines a set of privileges for users.

To create a template:

1.	Select Project · Security Templates... from the menu bar.
The Project Security Templates dialog opens.

2.	Click New....
The Template dialog opens.

3.	Type the name for the new template then click OK.
For example, you might want templates for superusers, general users, and guests.
The new template name appears in the Project Security Template dialog.
By default, the first three check boxes are selected, giving users the usual non-administrator rights. The Read check box is always selected and cannot be cleared whenever Modify is selected.

4.	Leave the Add check box selected if the users assigned to this template should be allowed to add files to a to-be-determined subproject. Clear it to prevent these users from adding files.

5.	Leave the Modify check box selected to allow users to check files in and out. Clear it to prevent these privileges.

6.	If you clear the Modify check box, you can also clear the Read check box, preventing users from checking out files.

7.	Select the Delete check box to allow users to delete files. Leave it cleared to prevent these users from deleting files.

 Related Topics


 Modify a security template

 When project security is enabled, only an administrator can modify a security template which defines a set of privileges for users.

To modify a security template:

1.	Select Project · Security Templates... from the menu bar.
The Project Security Templates dialog opens.

2.	Select the security template to be modified.

3.	Select and/or clear the appropriate check boxes.
The Add check box allows user to add files to a subproject.
The Read check box allows user to check out files from a subproject.
The Modify check box allows users to check files in and out.
If you select the Modify check box, the Read check box is automatically selected.
The Delete check box allows users to delete files from a subproject.

 Related Topics


 Delete a security template

 When project security is enabled, only an administrator can delete a security template which defines a set of privileges for users.

To delete a security template:

1.	Select Project · Security Templates... from the menu bar.
The Project Security Templates dialog opens.

2.	The Project Security Templates dialog opens.

3.	Select the security template to be deleted.

4.	Click Remove.
The template is deleted. It can no longer be used by any subproject.

 Related Topics


 Control privileges within a subproject

 When project security is enabled, only an administrator can set up security for a subproject. To setup subproject level security, you must create security templates and then assign users or groups to those templates on a subproject-by-subproject basis. A security template define a standard set of privileges that can be applied to different users in different subprojects. For example, the group testers can have superuser privileges only in the Test Suites subproject while the marketing group has superuser privileges only in the Marketing Materials subproject.

While you can create templates and assign users and groups under any circumstances, security is not enforced unless it is set as a project property. Administrators always have full privileges in any subproject. The templates apply only to non-administrators.

To assign users or groups of privileges within a subproject:

1.	Select a subproject from the project tree.

2.	Select Properties... from the Project menu or context menu.
Or,
Press Alt+Enter.
The Project Properties (for the root subproject) or the Subproject Properties dialog opens.

3.	Select the Users tab.

4.	Select a security template from the Template drop-down list box.
In this way, you select a standard set of privileges.

5.	Click Add....
The Add Users dialog opens.

6.	Select one or more users or groups from the list box, then click OK.
In this way, you determine to whom that standard set of privileges will apply.

7.	Repeat steps 4 through 6 for any other templates to be used within this subproject.
The end result for the User Manual subproject (in the StarDraw project) might be as shown in the following figure

To remove privileges from users or groups within a subproject:

1.	Select a subproject from the project tree.

2.	Select Properties... from the Project menu or context menu.
Or,
Press Alt+Enter.
The Project Properties (for the root subproject) or the Subproject Properties dialog opens.

3.	Select the Users tab.

4.	Select the names of one or more users or groups from the list box.

5.	Click Remove.

 Related Topics


 Use a prefix with the $Log$ keyword

$Log$ is the only keyword that can expand as more than one line. To insure that these lines are recognized as comments, you can attach a prefix to each line. You can provide different prefixes for files with different extensions. For example, you can use “rem” for .bat files.

 When project security is enabled, only an administrator can create prefixes.

To create a list of prefixes for $Log$ expansion (or add to that list):

1.	Select the root subproject from the project tree.

2.	Select Properties... from the Project menu or context menu.
Or,
Press Alt+Enter.
The Project Properties dialog opens.

3.	Select the Defaults tab.
The Defaults dialog opens.

4.	Select the Keyword Expansion check box (if it is not already checked).

5.	Click Settings….
The Keyword Settings dialog opens.

6.	Type the extension in the File Extension text box.

7.	Type the prefix for entries in files with that extension in the Line Prefix text box. Use up to 32 characters.

8.	Click Add.
Your extension/prefix combination appears in the File ext./Line prefix list box.

9.	Repeat steps 6 through 8 to add additional items to the list.

To remove an item from the list:

1.	Do steps 1 through 5 of the above procedure.

2.	Select the item to be deleted from the File ext./Line prefix list box.

3.	Click Remove.